From abe7663d8c8281cebf206f5b7306a3b97a06d1a3 Mon Sep 17 00:00:00 2001
From: Sam Reed <reedy@users.mediawiki.org>
Date: Thu, 13 Oct 2011 18:44:26 +0000
Subject: [PATCH] Documentation

Swap a lot of "@returns" to "@return"
---
 includes/EditPage.php                       | 2 +-
 includes/HttpFunctions.php                  | 6 +++---
 includes/installer/WebInstallerPage.php     | 2 +-
 includes/media/SVG.php                      | 2 +-
 includes/revisiondelete/RevisionDeleter.php | 9 +++++----
 5 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/includes/EditPage.php b/includes/EditPage.php
index cece348716..f2cdc00ef2 100644
--- a/includes/EditPage.php
+++ b/includes/EditPage.php
@@ -169,7 +169,7 @@ class EditPage {
 	 * Fetch initial editing page content.
 	 *
 	 * @param $def_text string
-	 * @returns mixed string on success, $def_text for invalid sections
+	 * @return mixed string on success, $def_text for invalid sections
 	 * @private
 	 */
 	function getContent( $def_text = '' ) {
diff --git a/includes/HttpFunctions.php b/includes/HttpFunctions.php
index aa69ae71e5..d24957142e 100644
--- a/includes/HttpFunctions.php
+++ b/includes/HttpFunctions.php
@@ -127,7 +127,7 @@ class Http {
 	 * @fixme this is wildly inaccurate and fails to actually check most stuff
 	 *
 	 * @param $uri Mixed: URI to check for validity
-	 * @returns Boolean
+	 * @return Boolean
 	 */
 	public static function isValidURI( $uri ) {
 		return preg_match(
@@ -525,7 +525,7 @@ class MWHttpRequest {
 	/**
 	 * Returns the cookie jar in use.
 	 *
-	 * @returns CookieJar
+	 * @return CookieJar
 	 */
 	public function getCookieJar() {
 		if ( !$this->respHeaders ) {
@@ -571,7 +571,7 @@ class MWHttpRequest {
 	 * Relative values of the "Location" header are incorrect as stated in RFC, however they do happen and modern browsers support them.
 	 * This function loops backwards through all locations in order to build the proper absolute URI - Marooned at wikia-inc.com
 	 *
-	 * @returns string
+	 * @return string
 	 */
 	public function getFinalUrl() {
 		$headers = $this->getResponseHeaders();
diff --git a/includes/installer/WebInstallerPage.php b/includes/installer/WebInstallerPage.php
index caf4fd6fb2..08235e3ebe 100644
--- a/includes/installer/WebInstallerPage.php
+++ b/includes/installer/WebInstallerPage.php
@@ -122,7 +122,7 @@ abstract class WebInstallerPage {
 	/**
 	 * Get the end tag of a fieldset.
 	 *
-	 * @returns string
+	 * @return string
 	 */
 	protected function getFieldsetEnd() {
 		return "</fieldset>\n";
diff --git a/includes/media/SVG.php b/includes/media/SVG.php
index 9a32cf6e17..986c164ca2 100644
--- a/includes/media/SVG.php
+++ b/includes/media/SVG.php
@@ -119,7 +119,7 @@ class SvgHandler extends ImageHandler {
 	* @param string $dstPath
 	* @param string $width
 	* @param string $height
-	* @returns TRUE/MediaTransformError
+	* @return true|MediaTransformError
 	*/
 	public function rasterize( $srcPath, $dstPath, $width, $height ) {
 		global $wgSVGConverters, $wgSVGConverter, $wgSVGConverterPath;
diff --git a/includes/revisiondelete/RevisionDeleter.php b/includes/revisiondelete/RevisionDeleter.php
index 7868cb73f9..9f05c620d3 100644
--- a/includes/revisiondelete/RevisionDeleter.php
+++ b/includes/revisiondelete/RevisionDeleter.php
@@ -65,10 +65,11 @@ class RevisionDeleter {
 		return $ret;
 	}
 
-	// Get DB field name for URL param...
-	// Future code for other things may also track
-	// other types of revision-specific changes.
-	// @returns string One of log_id/rev_id/fa_id/ar_timestamp/oi_archive_name
+	/** Get DB field name for URL param...
+	 * Future code for other things may also track
+	 * other types of revision-specific changes.
+	 * @return string One of log_id/rev_id/fa_id/ar_timestamp/oi_archive_name
+	 */
 	public static function getRelationType( $typeName ) {
 		if ( isset( SpecialRevisionDelete::$deprecatedTypeMap[$typeName] ) ) {
 			$typeName = SpecialRevisionDelete::$deprecatedTypeMap[$typeName];
-- 
2.20.1