SemanticMediaWiki / SemanticResultFormats

formats/array/SRF_Array.php

Doc Comments +16 added lines

@@ -135,6 +135,9 @@ 
 		return $output;
 	}
 	
+	/**
+	 * @param string $value
+	 */
 	protected function fillDeliveryArray( $array = 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 +26 added lines, -1 removed lines

@@ -47,7 +47,7 @@ 
 	 *
 	 * @param SMWQueryResult $queryResult
 	 *
-	 * @return string|boolean
+	 * @return string
 	 */
 	public function getFileName( SMWQueryResult $queryResult ) {
 		if ( $this->getSearchLabel( SMW_OUTPUT_WIKI ) != '' ) {
@@ -222,6 +222,31 @@ 
 	private $URI;
 	private $fields = array();
 
+	/**
+	 * @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/SRFC_HistoricalDate.php

Doc Comments +3 added lines

@@ -26,6 +26,9 @@
 
 	protected $m_date; // the Julian day
 
+	/**
+	 * @param integer $day
+	 */
 	function create( $year, $month, $day ) {
 		if ( $year < 1582 ||
 			( $year == 1582 && ( $month < 10 || ( $month == 10 && $day < 15 ) ) ) ) {

formats/dygraphs/SRF_Dygraphs.php

Doc Comments +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
 	 * @since 1.8
 	 *
 	 * @param SMWQueryResult $result
-	 * @param $outputMode
+	 * @param integer $outputMode
 	 *
 	 * @return array
 	 */

formats/Exhibit/SRF_Exhibit.php

Doc Comments +4 added lines

@@ -30,6 +30,10 @@
 	}
 
 	// /Tries to determine the namespace in the event it got lost
+
+	/**
+	 * @param SMWQueryResult $res
+	 */
 	protected function determineNamespace( $res ) {
 		$row = $res->getNext();
 		if ( $row != null ) {

formats/Filtered/SRF_Filtered.php

Doc Comments +3 added lines

@@ -77,6 +77,9 @@
 	private $mParams;
 	private $mFiltersOnTop;
 
+	/**
+	 * @param boolean $hasTemplates
+	 */
 	public function hasTemplates ( $hasTemplates = null ) {
 		$ret = $this->hasTemplates;
 		if ( is_bool( $hasTemplates ) ) {

formats/Filtered/views/SRF_FV_Calendar.php

Doc Comments +1 added lines, -1 removed lines

@@ -219,7 +219,7 @@
 	/**
 	 * Returns the name of the resource module to load for this view.
 	 *
-	 * @return string|array
+	 * @return string
 	 */
 	public function getResourceModules() {
 		return 'ext.srf.filtered.calendar-view';

formats/Filtered/views/SRF_FV_Table.php

Doc Comments +5 added lines, -1 removed lines

@@ -136,6 +136,10 @@ 
 		);
 	}
 
+	/**
+	 * @param integer $outputmode
+	 * @param string[] $columnClasses
+	 */
 	private function getTableRows( $queryResults, $outputmode, $columnClasses) {
 		$tableRows = array();
 		
@@ -254,7 +258,7 @@ 
 	/**
 	 * Returns the name of the resource module to load for this view.
 	 *
-	 * @return string|array
+	 * @return string
 	 */
 	public function getResourceModules() {
 		return 'ext.srf.filtered.table-view';

formats/graphviz/SRF_Process.php

Doc Comments +37 added lines, -2 removed lines

@@ -505,8 +505,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
 	 */
 	public function makeNode( $id, $label ) {
@@ -542,6 +542,10 @@ 
 
 	}
 
+	/**
+	 * @param string $id
+	 * @param string $label
+	 */
 	public function makeRole( $id, $label ) {
 		// check if role exists
 		if ( isset( $this->m_roles[$id] ) ) {
@@ -561,6 +565,10 @@ 
 
 	}
 
+	/**
+	 * @param string $id
+	 * @param string $label
+	 */
 	public function makeRessource( $id, $label ) {
 		// check if res exists
 		if ( isset( $this->m_ressources[$id] ) ) {
@@ -644,6 +652,9 @@ 
 		return $this->m_showRessources;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setGraphName( $name ) {
 		$this->m_graphName = $name;
 	}
@@ -653,18 +664,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;
 	}
@@ -677,6 +700,9 @@ 
 		$this->m_showRedLinks = $show;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setHighlightNode( $name ) {
 		$this->m_highlightNode = $name;
 	}
@@ -857,10 +883,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;
 	}
@@ -1176,6 +1208,9 @@ 
 		$node->addEdgeIn($this);
 	}
 
+	/**
+	 * @param string $cond
+	 */
 	public function setConditionText($cond){
 		$this->m_con_text = $cond;
 	}