From 25971af694f33da3042b6df5137834dcd20fe5e8 Mon Sep 17 00:00:00 2001
From: umherirrender <umherirrender_de.wp@web.de>
Date: Sat, 9 Aug 2014 21:26:14 +0200
Subject: [PATCH] Cleanup some docs (maintenance)

- Fixed spacing inside docs
- Makes beginning of @param/@return in capital

Change-Id: I864b8b3f1f67e34e369aba7aadaf87e7752c894d
---
 maintenance/findHooks.php          | 16 ++++++++--------
 maintenance/language/languages.inc |  2 +-
 maintenance/parse.php              |  2 +-
 maintenance/sql.php                |  2 +-
 maintenance/sqlite.inc             |  2 +-
 5 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/maintenance/findHooks.php b/maintenance/findHooks.php
index 9929cf9b67..074388f68d 100644
--- a/maintenance/findHooks.php
+++ b/maintenance/findHooks.php
@@ -136,7 +136,7 @@ class FindHooks extends Maintenance {
 
 	/**
 	 * Get the hook documentation, either locally or from MediaWiki.org
-	 * @return array of documented hooks
+	 * @return Array of documented hooks
 	 */
 	private function getHooksFromDoc( $doc ) {
 		if ( $this->hasOption( 'online' ) ) {
@@ -148,8 +148,8 @@ class FindHooks extends Maintenance {
 
 	/**
 	 * Get hooks from a local file (for example docs/hooks.txt)
-	 * @param string $doc filename to look in
-	 * @return array Array of documented hooks
+	 * @param string $doc Filename to look in
+	 * @return Array of documented hooks
 	 */
 	private function getHooksFromLocalDoc( $doc ) {
 		$m = array();
@@ -161,7 +161,7 @@ class FindHooks extends Maintenance {
 
 	/**
 	 * Get hooks from www.mediawiki.org using the API
-	 * @return array of documented hooks
+	 * @return Array of documented hooks
 	 */
 	private function getHooksFromOnlineDoc() {
 		// All hooks
@@ -199,7 +199,7 @@ class FindHooks extends Maintenance {
 	/**
 	 * Get hooks from a PHP file
 	 * @param string $file Full filename to the PHP file.
-	 * @return array of hooks found.
+	 * @return Array of hooks found.
 	 */
 	private function getHooksFromFile( $file ) {
 		$content = file_get_contents( $file );
@@ -216,7 +216,7 @@ class FindHooks extends Maintenance {
 	/**
 	 * Get hooks from the source code.
 	 * @param string $path Directory where the include files can be found
-	 * @return array Array of hooks found.
+	 * @return Array of hooks found.
 	 */
 	private function getHooksFromPath( $path ) {
 		$hooks = array();
@@ -236,7 +236,7 @@ class FindHooks extends Maintenance {
 	/**
 	 * Get bad hooks (where the hook name could not be determined) from a PHP file
 	 * @param string $file Full filename to the PHP file.
-	 * @return array Array of bad wfRunHooks() lines
+	 * @return Array of bad wfRunHooks() lines
 	 */
 	private function getBadHooksFromFile( $file ) {
 		$content = file_get_contents( $file );
@@ -254,7 +254,7 @@ class FindHooks extends Maintenance {
 	/**
 	 * Get bad hooks from the source code.
 	 * @param string $path Directory where the include files can be found
-	 * @return array Array of bad wfRunHooks() lines
+	 * @return Array of bad wfRunHooks() lines
 	 */
 	private function getBadHooksFromPath( $path ) {
 		$hooks = array();
diff --git a/maintenance/language/languages.inc b/maintenance/language/languages.inc
index 9c9b7ff07c..fb496cbc00 100644
--- a/maintenance/language/languages.inc
+++ b/maintenance/language/languages.inc
@@ -55,7 +55,7 @@ class Languages {
 	/** @var array Magic words */
 	protected $mMagicWords;
 
-	/** @var  array Special page aliases */
+	/** @var array Special page aliases */
 	protected $mSpecialPageAliases;
 
 	/**
diff --git a/maintenance/parse.php b/maintenance/parse.php
index 9af57da9f8..638d7c5b2a 100644
--- a/maintenance/parse.php
+++ b/maintenance/parse.php
@@ -113,7 +113,7 @@ class CLIParser extends Maintenance {
 	 * Default title is 'CLIParser', it can be overriden with the option
 	 * --title <Your:Title>
 	 *
-	 * @return Title object
+	 * @return Title
 	 */
 	protected function getTitle() {
 		$title = $this->getOption( 'title' )
diff --git a/maintenance/sql.php b/maintenance/sql.php
index c947a4c36f..389b2701e5 100644
--- a/maintenance/sql.php
+++ b/maintenance/sql.php
@@ -136,7 +136,7 @@ class MwSql extends Maintenance {
 	/**
 	 * Print the results, callback for $db->sourceStream()
 	 * @param ResultWrapper $res The results object
-	 * @param DatabaseBase $db object
+	 * @param DatabaseBase $db
 	 */
 	public function sqlPrintResult( $res, $db ) {
 		if ( !$res ) {
diff --git a/maintenance/sqlite.inc b/maintenance/sqlite.inc
index 9729a726bb..43b259806c 100644
--- a/maintenance/sqlite.inc
+++ b/maintenance/sqlite.inc
@@ -42,7 +42,7 @@ class Sqlite {
 	 * Will throw exceptions on SQL errors
 	 * @param array|string $files
 	 * @throws MWException
-	 * @return string|bool true if no error or error string in case of errors
+	 * @return True if no error or error string in case of errors
 	 */
 	public static function checkSqlSyntax( $files ) {
 		if ( !Sqlite::isPresent() ) {
-- 
2.20.1