From: Thiemo Mättig <thiemo.maettig@wikimedia.de>
Date: Wed, 9 Dec 2015 17:20:41 +0000 (+0100)
Subject: Fix various mistakes in PHPDoc comments
X-Git-Tag: 1.31.0-rc.0~8753^2
X-Git-Url: http://git.cyclocoop.org/%22%20.%20generer_url_ecrire%28%22articles_versions%22%2C%22id_article=%24id_article%22%29%20.%20%22?a=commitdiff_plain;h=53c5a5297010ac9b0a122422e63a30c46577df00;p=lhc%2Fweb%2Fwiklou.git

Fix various mistakes in PHPDoc comments

Change-Id: I434207f61e0663f2d2c9a076296c2e0d04a3fafb
---

diff --git a/includes/api/ApiFormatRaw.php b/includes/api/ApiFormatRaw.php
index 9dbd4a553f..b1a9c984f0 100644
--- a/includes/api/ApiFormatRaw.php
+++ b/includes/api/ApiFormatRaw.php
@@ -36,7 +36,7 @@ class ApiFormatRaw extends ApiFormatBase {
 
 	/**
 	 * @param ApiMain $main
-	 * @param ApiFormatBase |null $errorFallback Object to fall back on for errors
+	 * @param ApiFormatBase|null $errorFallback Object to fall back on for errors
 	 */
 	public function __construct( ApiMain $main, ApiFormatBase $errorFallback = null ) {
 		parent::__construct( $main, 'raw' );
diff --git a/includes/db/DatabaseUtility.php b/includes/db/DatabaseUtility.php
index 969ed5e0f2..2bd0770950 100644
--- a/includes/db/DatabaseUtility.php
+++ b/includes/db/DatabaseUtility.php
@@ -113,11 +113,11 @@ class ResultWrapper implements Iterator {
 	}
 
 	/**
-	 * Fetch the next row from the given result object, in object form.
-	 * Fields can be retrieved with $row->fieldname, with fields acting like
-	 * member variables.
+	 * Fetch the next row from the given result object, in object form. Fields can be retrieved with
+	 * $row->fieldname, with fields acting like member variables. If no more rows are available,
+	 * false is returned.
 	 *
-	 * @return stdClass
+	 * @return stdClass|bool
 	 * @throws DBUnexpectedError Thrown if the database returns an error
 	 */
 	function fetchObject() {
@@ -125,10 +125,10 @@ class ResultWrapper implements Iterator {
 	}
 
 	/**
-	 * Fetch the next row from the given result object, in associative array
-	 * form. Fields are retrieved with $row['fieldname'].
+	 * Fetch the next row from the given result object, in associative array form. Fields are
+	 * retrieved with $row['fieldname']. If no more rows are available, false is returned.
 	 *
-	 * @return array
+	 * @return array|bool
 	 * @throws DBUnexpectedError Thrown if the database returns an error
 	 */
 	function fetchRow() {
diff --git a/includes/resourceloader/ResourceLoaderFileModule.php b/includes/resourceloader/ResourceLoaderFileModule.php
index ef98400298..dd7c5a3932 100644
--- a/includes/resourceloader/ResourceLoaderFileModule.php
+++ b/includes/resourceloader/ResourceLoaderFileModule.php
@@ -445,7 +445,7 @@ class ResourceLoaderFileModule extends ResourceLoaderModule {
 
 	/**
 	 * Gets list of names of modules this module depends on.
-	 * @param ResourceLoaderContext context
+	 * @param ResourceLoaderContext|null $context
 	 * @return array List of module names
 	 */
 	public function getDependencies( ResourceLoaderContext $context = null ) {
diff --git a/includes/tidy/TidyDriverBase.php b/includes/tidy/TidyDriverBase.php
index 61fd3e4f79..06775ef021 100644
--- a/includes/tidy/TidyDriverBase.php
+++ b/includes/tidy/TidyDriverBase.php
@@ -33,8 +33,8 @@ abstract class TidyDriverBase {
 	/**
 	 * Clean up HTML
 	 *
-	 * @param string HTML document fragment to clean up
-	 * @param string The corrected HTML output
+	 * @param string $text HTML document fragment to clean up
+	 * @return string The corrected HTML output
 	 */
 	abstract public function tidy( $text );
 }