SemanticMediaWiki / SemanticResultFormats

formats/array/SRF_Array.php

Doc Comments +15 added lines

@@ -153,6 +153,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	protected function fillDeliveryArray( $array = [], $value = null ) {
 		if ( !is_null( $value ) ) { //don't create any empty entries
 			$array[] = $value;
@@ -194,6 +197,11 @@ 
 	}
 
 	//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
 		{
@@ -202,6 +210,10 @@ 
 		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;
@@ -272,6 +284,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $dfltCacheKey
+	 */
 	protected function initializeCfgValue( $dfltVal, $dfltCacheKey ) {
 		$cache = &self::$mDefaultSeps[$dfltCacheKey];
 		if ( !isset( $cache ) ) {

formats/filtered/src/View/MapView.php

Doc Comments +2 added lines, -2 removed lines

@@ -270,7 +270,7 @@ 
 	}
 
 	/**
-	 * @param $prop
+	 * @param string $prop
 	 *
 	 * @return array
 	 */
@@ -322,7 +322,7 @@ 
 	}
 
 	/**
-	 * @return bool
+	 * @return string|null
 	 */
 	public function getInitError() {
 		return $this->getMapProvider() === '' ? 'srf-filtered-map-provider-missing-error' : null;

formats/graphviz/SRF_Process.php

Doc Comments +37 added lines, -2 removed lines

@@ -508,8 +508,8 @@ 
 	 * This method should be used for getting new or existing nodes
 	 * If a node does not exist yet, it will be created
 	 *
-	 * @param $id            string, node id
-	 * @param $label        string, node label
+	 * @param string $id            string, node id
+	 * @param string $label        string, node label
 	 *
 	 * @return                Object of type ProcessNode
 	 */
@@ -548,6 +548,10 @@ 
 
 	}
 
+	/**
+	 * @param string $id
+	 * @param string $label
+	 */
 	public function makeRole( $id, $label ) {
 		// check if role exists
 		if ( isset( $this->m_roles[$id] ) ) {
@@ -567,6 +571,10 @@ 
 
 	}
 
+	/**
+	 * @param string $id
+	 * @param string $label
+	 */
 	public function makeRessource( $id, $label ) {
 		// check if res exists
 		if ( isset( $this->m_ressources[$id] ) ) {
@@ -652,6 +660,9 @@ 
 		return $this->m_showRessources;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setGraphName( $name ) {
 		$this->m_graphName = $name;
 	}
@@ -663,18 +674,30 @@ 
 		return $this->m_graphName;
 	}
 
+	/**
+	 * @param string $size
+	 */
 	public function setGraphSize( $size ) {
 		$this->m_graphSize = $size;
 	}
 
+	/**
+	 * @param string $rankdir
+	 */
 	public function setRankdir( $rankdir ) {
 		$this->m_rankdir = $rankdir;
 	}
 
+	/**
+	 * @param string $color
+	 */
 	public function setClusterColor( $color ) {
 		$this->m_clusterColor = $color;
 	}
 
+	/**
+	 * @param string $color
+	 */
 	public function setHighlightColor( $color ) {
 		$this->m_highlightColor = $color;
 	}
@@ -687,6 +710,9 @@ 
 		$this->m_showRedLinks = $show;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setHighlightNode( $name ) {
 		$this->m_highlightNode = $name;
 	}
@@ -876,10 +902,16 @@ 
 		return $this->m_status;
 	}
 
+	/**
+	 * @param string $color
+	 */
 	public function setFontColor( $color ) {
 		$this->m_fontColor = $color;
 	}
 
+	/**
+	 * @param ProcessGraph $proc
+	 */
 	public function setProcess( $proc ) {
 		$this->m_process = $proc;
 	}
@@ -1217,6 +1249,9 @@ 
 		$node->addEdgeIn( $this );
 	}
 
+	/**
+	 * @param string $cond
+	 */
 	public function setConditionText( $cond ) {
 		$this->m_con_text = $cond;
 	}

formats/outline/SRF_Outline.php

Doc Comments +6 added lines

@@ -49,6 +49,9 @@ 
 		$this->mUnsortedItems = $items;
 	}
 
+	/**
+	 * @param SRFOutlineItem $item
+	 */
 	function addItem( $item ) {
 		$this->mUnsortedItems[] = $item;
 	}
@@ -140,6 +143,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param SRFOutlineTree $outline_tree
+	 */
 	function printTree( $outline_tree, $level = 0 ) {
 		$text = "";
 		if ( !is_null( $outline_tree->mUnsortedItems ) ) {

formats/slideshow/SRF_SlideShowApi.php

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,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/tree/TreeNode.php

Doc Comments +1 added lines, -1 removed lines

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

formats/tree/TreeNodeVisitor.php

Doc Comments +1 added lines

@@ -168,6 +168,7 @@
 
 	/**
 	 * @param \SMWResultArray $cell
+	 * @param integer $columnNumber
 	 *
 	 * @return string
 	 */