SemanticMediaWiki / SemanticMediaWiki

includes/queryprinters/CategoryResultPrinter.php

Doc Comments +4 added lines

@@ -229,6 +229,10 @@
 		return ByLanguageCollationMapper::getInstance()->findFirstLetterForCategory( $sortKey );
 	}
 
+	/**
+	 * @param SMWQueryResult $res
+	 * @param boolean $first_col
+	 */
 	private function addRowFieldsToTemplate( $res, $row, &$first_col, &$columnIndex, $templateRenderer ) {
 
 		// explicitly number parameters for more robust parsing (values may contain "=")

includes/queryprinters/DsvResultPrinter.php

Doc Comments +1 added lines, -2 removed lines

@@ -59,7 +59,7 @@ 
 	 *
 	 * @param SMWQueryResult $queryResult
 	 *
-	 * @return string|boolean
+	 * @return string
 	 */
 	public function getFileName( SMWQueryResult $queryResult ) {
 		return $this->fileName;
@@ -87,7 +87,6 @@ 
 	 *
 	 * @since 1.6
 	 *
-	 * @param SMWQueryResult $res
 	 *
 	 * @return string
 	 */

includes/queryprinters/ListResultPrinter.php

Doc Comments +4 added lines, -1 removed lines

@@ -393,7 +393,7 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @param $row
+	 * @param SMWResultArray[] $row
 	 *
 	 * @return string
 	 */
@@ -422,6 +422,9 @@ 
 		$this->templateRenderer->addField( '#', $this->numRows );
 	}
 
+	/**
+	 * @param SMWQueryResult $queryResult
+	 */
 	protected function addCommonTemplateFields( $queryResult ) {
 
 		if ( $this->mUserParam ) {

includes/queryprinters/RdfResultPrinter.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
 	 *
 	 * @param SMWQueryResult $queryResult
 	 *
-	 * @return string|boolean
+	 * @return string
 	 */
 	public function getFileName( SMWQueryResult $queryResult ) {
 		return $this->syntax == 'turtle' ? 'result.ttl' : 'result.rdf';

includes/queryprinters/ResultPrinter.php

Doc Comments +3 added lines, -3 removed lines

@@ -188,7 +188,7 @@ 
 	 *
 	 * @param $results SMWQueryResult
 	 * @param $fullParams array
-	 * @param $outputMode integer
+	 * @param integer $outputMode integer
 	 *
 	 * @return string
 	 */
@@ -465,7 +465,7 @@ 
 	/**
 	 * @see SMWIResultPrinter::getQueryMode
 	 *
-	 * @param $context
+	 * @param integer $context
 	 *
 	 * @return integer
 	 */
@@ -607,7 +607,7 @@ 
 	 *
 	 * @param ParamDefinition[] $definitions
 	 *
-	 * @return array
+	 * @return \ParamProcessor\IParamDefinition[]
 	 */
 	public function getParamDefinitions( array $definitions ) {
 		return array_merge( $definitions, $this->getParameters() );

includes/SemanticData.php

Doc Comments +3 added lines, -3 removed lines

@@ -173,7 +173,7 @@ 
 	 * output, then the Semdata container will at least look as if properly
 	 * initialised (though empty).
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function __sleep() {
 		return array( 'mSubject', 'mPropVals', 'mProperties', 'subSemanticData', 'mHasVisibleProps', 'mHasVisibleSpecs', 'lastModified' );
@@ -367,7 +367,7 @@ 
 	 * Store a value for a given property identified by its text label
 	 * (without namespace prefix).
 	 *
-	 * @param $propertyName string
+	 * @param string $propertyName string
 	 * @param $dataItem SMWDataItem
 	 */
 	public function addPropertyValue( $propertyName, SMWDataItem $dataItem ) {
@@ -592,7 +592,7 @@ 
 	 *
 	 * @since 1.9
 	 *
-	 * @param string $subobjectName|null
+	 * @param string $subobjectName
 	 *
 	 * @return boolean
 	 */

includes/SMW_Outputs.php

Doc Comments +1 added lines, -2 removed lines

@@ -65,7 +65,6 @@ 
 	 * recorded multiple times in SMWOutputs.
 	 *
 	 * @param string $id
-	 * @param string $item
 	 */
 	public static function requireScript( $id, $script ) {
 		self::$scripts[$id] = $script;
@@ -81,7 +80,7 @@ 
 	 * Support for calling this with the old constants SMW_HEADER_STYLE
 	 * and SMW_HEADER_TOOLTIP will vanish in SMW 1.7 at the latest.
 	 *
-	 * @param mixed $id
+	 * @param string $id
 	 * @param string $item
 	 */
 	public static function requireHeadItem( $id, $item = '' ) {

includes/specials/SMW_SpecialBrowse.php

Doc Comments +9 added lines, -3 removed lines

@@ -151,7 +151,7 @@ 
 	 * @param[in] $left bool  Should properties be displayed on the left side?
 	 * @param[in] $incoming bool  Is this an incoming? Or an outgoing?
 	 *
-	 * @return A string containing the HTML with the factbox
+	 * @return string string containing the HTML with the factbox
 	 */
 	private function displayData( SMWSemanticData $data, $left = true, $incoming = false ) {
 		// Some of the CSS classes are different for the left or the right side.
@@ -245,6 +245,7 @@ 
 	 * @param[in] $property SMWPropertyValue  The property this value is linked to the subject with
 	 * @param[in] $value SMWDataValue  The actual value
 	 * @param[in] $incoming bool  If this is an incoming or outgoing link
+	 * @param boolean $incoming
 	 *
 	 * @return string  HTML with the link to the article, browse, and search pages
 	 */
@@ -267,7 +268,7 @@ 
 	/**
 	 * Displays the subject that is currently being browsed to.
 	 *
-	 * @return A string containing the HTML with the subject line
+	 * @return string string containing the HTML with the subject line
 	 */
 	private function displayHead() {
 		global $wgOut;
@@ -300,6 +301,7 @@ 
 	 * Creates the HTML for the bottom bar including the links with further navigation options.
 	 *
 	 * @param[in] $more bool  Are there more inproperties to be displayed?
+	 * @param boolean $more
 	 * @return string  HTMl with the bottom bar
 	 */
 	private function displayBottom( $more ) {
@@ -329,6 +331,9 @@ 
 	 * @param[in] $out bool  Should the linked to page include outgoing properties?
 	 * @param[in] $in bool  Should the linked to page include incoming properties?
 	 * @param[in] $offset int  What is the offset for the incoming properties?
+	 * @param boolean $out
+	 * @param boolean $in
+	 * @param integer $offset
 	 *
 	 * @return string  HTML with the link to this page
 	 */
@@ -418,7 +423,7 @@ 
 	/**
 	 * Creates the query form in order to quickly switch to a specific article.
 	 *
-	 * @return A string containing the HTML for the form
+	 * @return string string containing the HTML for the form
 	 */
 	private function queryForm() {
 		SMWOutputs::requireResource( 'ext.smw.browse' );
@@ -445,6 +450,7 @@ 
 
 	/**
 	 * FIXME MW 1.25
+	 * @param string $key
 	 */
 	private function addExternalHelpLinkFor( $key ) {
 

includes/specials/SpecialConcepts.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 	 * @param integer $from
 	 * @param integer $until
 	 *
-	 * @return DIWikiPage[]
+	 * @return \SMWDIWikiPage[]
 	 */
 	public function getResults( $limit, $from, $until ) {
 		$description = new SomeProperty( new DIProperty( '_CONC' ), new ThingDescription() );