SemanticMediaWiki / SemanticResultFormats

SemanticResultFormats.hooks.php

Doc Comments +2 added lines, -2 removed lines

@@ -143,7 +143,7 @@ 
 	 *
 	 * @param &$vars Array of variables to be added into the output of the startup module.
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public static function onResourceLoaderGetConfigVars( &$vars ) {
 
@@ -165,7 +165,7 @@ 
 	 * @param User $user
 	 * @param array $preferences
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public static function onGetPreferences( $user, &$preferences ) {
 

formats/vcard/SRF_vCard.php

Doc Comments +11 added lines

@@ -385,6 +385,14 @@ 
 
 	/**
 	 * Constructor for a single item in the vcard. Requires the URI of the item.
+	 * @param string $prefix
+	 * @param string $additionalname
+	 * @param string $suffix
+	 * @param string $jobtitle
+	 * @param string $role
+	 * @param string $department
+	 * @param string $category
+	 * @param string $note
 	 */
 	public function __construct( Title $t, $prefix, $firstname, $lastname, $additionalname, $suffix, $fullname, $tels, $addresses, $emails, $birthday, $jobtitle, $role, $organization, $department, $category, $url, $note ) {
 		$this->uri = $t->getFullURL();
@@ -494,6 +502,7 @@ 
 
 	/**
 	 * Constructor for a single address item in the vcard item.
+	 * @param string $type
 	 */
 	public function __construct( $type, $postofficebox, $extendedaddress, $street, $locality, $region, $postalcode, $country ) {
 		$this->type = $type;
@@ -526,6 +535,7 @@ 
 
 	/**
 	 * Constructor for a single telephone item in the vcard item.
+	 * @param string $type
 	 */
 	public function __construct( $type, $telnumber ) {
 		$this->type = $type;  // may be a vCard value list using ",", no escaping
@@ -552,6 +562,7 @@ 
 
 	/**
 	 * Constructor for a email telephone item in the vcard item.
+	 * @param string $type
 	 */
 	public function __construct( $type, $emailaddress ) {
 		$this->type = $type;

formats/array/SRF_Array.php

Doc Comments +16 added lines

@@ -135,6 +135,9 @@ 
 		return $output;
 	}
 	
+	/**
+	 * @param string $value
+	 */
 	protected function fillDeliveryArray( $array = [], $value = null ) {
 		if( ! is_null( $value ) ) { //don't create any empty entries
 			$array[] = $value;
@@ -166,11 +169,21 @@ 
 			/** @ToDo: System for Default values?... **/
 	}
 	//represented by an array of record fields or just a single array value:
+
+	/**
+	 * @param boolean $containsRecord
+	 * @param boolean $isPageTitle
+	 */
 	protected function deliverSingleManyValuesData( $value_items, $containsRecord, $isPageTitle ) {
 		if( empty( $value_items ) ) //happens when one of the higher functions delivers null
 			return null;
 		return implode( $this->mRecordSep, $value_items );
 	}
+
+	/**
+	 * @param boolean $isMissingProperty
+	 * @param boolean $isPageTitle
+	 */
 	protected function deliverPropertiesManyValues( $manyValue_items, $isMissingProperty, $isPageTitle, SMWResultArray $data ) {
 		if( empty( $manyValue_items ) )
 			return null;
@@ -236,6 +249,9 @@ 
 		return true;
 	}
 	
+	/**
+	 * @param string $dfltCacheKey
+	 */
 	protected function initializeCfgValue( $dfltVal, $dfltCacheKey ) {		
 		$cache = &self::$mDefaultSeps[ $dfltCacheKey ];
 		if( ! isset( $cache ) ) {

formats/bibtex/SRF_BibTeX.php

Doc Comments +25 added lines

@@ -222,6 +222,31 @@
 	private $URI;
 	private $fields = [];
 
+	/**
+	 * @param string $type
+	 * @param string $address
+	 * @param string $annote
+	 * @param string $booktitle
+	 * @param string $chapter
+	 * @param string $crossref
+	 * @param string $doi
+	 * @param string $edition
+	 * @param string $eprint
+	 * @param string $howpublished
+	 * @param string $institution
+	 * @param string $journal
+	 * @param string $key
+	 * @param string $note
+	 * @param string $number
+	 * @param string $organization
+	 * @param string $pages
+	 * @param string $publisher
+	 * @param string $school
+	 * @param string $series
+	 * @param string $title
+	 * @param string $url
+	 * @param string $volume
+	 */
 	public function __construct( $type, $address, $annote, $author, $booktitle, $chapter, $crossref, $doi, $edition, $editor, $eprint, $howpublished, $institution, $journal, $key, $month, $note, $number, $organization, $pages, $publisher, $school, $series, $title, $url, $volume, $year ) {
 		if ( $type ) $this->bibTeXtype = ucfirst( $type ); else $this->bibTeXtype = 'Book';
 

formats/calendar/SRF_Calendar.php

Doc Comments +1 added lines

@@ -77,6 +77,7 @@
 	 * @see SMWResultPrinter::getResultText()
 	 *
 	 * @todo Split up megamoth
+	 * @param integer $outputmode
 	 */
 	protected function getResultText( SMWQueryResult $res, $outputmode ) {
 		$events = [];

formats/slideshow/SRF_SlideShowApi.php

Doc Comments +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
 
 	/**
 	 * Returns the description string for this module
-	 * @return mixed string or array of strings
+	 * @return string[] string or array of strings
 	 */
 	protected function getDescription() {
 		return [

formats/gallery/Gallery.php

Unused Use Statements -2 removed lines

@@ -3,13 +3,11 @@
 namespace SRF;
 
 use SMW\ResultPrinter;
-
 use SMWQueryResult;
 use SMWPrintRequest;
 use SMWDataItem;
 use SMWOutputs;
 use SRFUtils;
-
 use Html;
 use Title;
 

formats/tree/TreeNodeVisitor.php

Doc Comments +1 added lines

@@ -164,6 +164,7 @@
 
 	/**
 	 * @param \SMWResultArray $cell
+	 * @param integer $columnNumber
 	 * @return string
 	 */
 	protected function getLabelForCell( $cell, $columnNumber ) {

formats/tree/TreeNode.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 
 	/**
 	 * @param NodeInterface $child
-	 * @return NodeTrait
+	 * @return TreeNode
 	 * @throws Exception
 	 */
 	public function addChild( NodeInterface $child ) {