From b2a7aafbed9b2f9070c15b8671c95ed582d36735 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex.wiki@gmail.com>
Date: Wed, 25 Jul 2012 21:31:06 +0200
Subject: [PATCH] Improve documentation of maintenance scripts.

Change-Id: I93e80edcfc3dc2d5630f7514808cafc22daf39f7
---
 maintenance/jsparse.php              |  8 +++++++-
 maintenance/lag.php                  |  5 +++++
 maintenance/mctest.php               | 11 +++++++++--
 maintenance/mergeMessageFileList.php |  7 +++++++
 maintenance/migrateUserGroup.php     |  6 ++++++
 maintenance/minify.php               |  5 +++++
 maintenance/moveBatch.php            |  8 +++++++-
 maintenance/namespaceDupes.php       |  9 ++++++++-
 maintenance/nextJobDB.php            |  6 ++++++
 maintenance/nukeNS.php               |  8 +++++++-
 maintenance/nukePage.php             |  6 ++++++
 maintenance/orphans.php              | 15 +++++++++++----
 12 files changed, 84 insertions(+), 10 deletions(-)

diff --git a/maintenance/jsparse.php b/maintenance/jsparse.php
index 2c38ed9d13..c0a4dbaa32 100644
--- a/maintenance/jsparse.php
+++ b/maintenance/jsparse.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Maintenance script to do test JavaScript validity parses using jsmin+'s parser
+ * Test JavaScript validity parses using jsmin+'s parser
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,11 +17,17 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script to do test JavaScript validity parses using jsmin+'s parser
+ *
+ * @ingroup Maintenance
+ */
 class JSParseHelper extends Maintenance {
 	var $errs = 0;
 
diff --git a/maintenance/lag.php b/maintenance/lag.php
index dc8bff5f8c..19c549a547 100644
--- a/maintenance/lag.php
+++ b/maintenance/lag.php
@@ -23,6 +23,11 @@
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script to show database lag.
+ *
+ * @ingroup Maintenance
+ */
 class DatabaseLag extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/mctest.php b/maintenance/mctest.php
index 088eaa34b1..ed8250b122 100644
--- a/maintenance/mctest.php
+++ b/maintenance/mctest.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * This script makes several 'set', 'incr' and 'get' requests on every
- * memcached server and shows a report.
+ * Makes several 'set', 'incr' and 'get' requests on every memcached
+ * server and shows a report.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,11 +18,18 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that  makes several 'set', 'incr' and 'get' requests
+ * on every memcached server and shows a report.
+ *
+ * @ingroup Maintenance
+ */
 class mcTest extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/mergeMessageFileList.php b/maintenance/mergeMessageFileList.php
index 6a9baa824f..8107016f46 100644
--- a/maintenance/mergeMessageFileList.php
+++ b/maintenance/mergeMessageFileList.php
@@ -28,6 +28,13 @@ define( 'MW_NO_EXTENSION_MESSAGES', 1 );
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 $maintClass = 'MergeMessageFileList';
 $mmfl = false;
+
+/**
+ * Maintenance script that merges $wgExtensionMessagesFiles from various
+ * extensions to produce a single array containing all message files.
+ *
+ * @ingroup Maintenance
+ */
 class MergeMessageFileList extends Maintenance {
 
 	function __construct() {
diff --git a/maintenance/migrateUserGroup.php b/maintenance/migrateUserGroup.php
index 297aaf3691..451b598be9 100644
--- a/maintenance/migrateUserGroup.php
+++ b/maintenance/migrateUserGroup.php
@@ -17,11 +17,17 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that re-assigns users from an old group to a new one.
+ *
+ * @ingroup Maintenance
+ */
 class MigrateUserGroup extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/minify.php b/maintenance/minify.php
index e1fd862d82..b17d8fe73a 100644
--- a/maintenance/minify.php
+++ b/maintenance/minify.php
@@ -23,6 +23,11 @@
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that minifies a file or set of files.
+ *
+ * @ingroup Maintenance
+ */
 class MinifyScript extends Maintenance {
 	var $outDir;
 
diff --git a/maintenance/moveBatch.php b/maintenance/moveBatch.php
index a7739c2318..f84699494b 100644
--- a/maintenance/moveBatch.php
+++ b/maintenance/moveBatch.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Maintenance script to move a batch of pages
+ * Move a batch of pages.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  * @author Tim Starling
  *
@@ -35,6 +36,11 @@
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script to move a batch of pages.
+ *
+ * @ingroup Maintenance
+ */
 class MoveBatch extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/namespaceDupes.php b/maintenance/namespaceDupes.php
index 74bd657972..e2de686cab 100644
--- a/maintenance/namespaceDupes.php
+++ b/maintenance/namespaceDupes.php
@@ -2,7 +2,7 @@
 /**
  * Check for articles to fix after adding/deleting namespaces
  *
- * Copyright (C) 2005-2007 Brion Vibber <brion@pobox.com>
+ * Copyright © 2005-2007 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -20,11 +20,18 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that checks for articles to fix after
+ * adding/deleting namespaces.
+ *
+ * @ingroup Maintenance
+ */
 class NamespaceConflictChecker extends Maintenance {
 
 	/**
diff --git a/maintenance/nextJobDB.php b/maintenance/nextJobDB.php
index ac4e723b5d..bee4065602 100644
--- a/maintenance/nextJobDB.php
+++ b/maintenance/nextJobDB.php
@@ -17,12 +17,18 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @todo Make this work on PostgreSQL and maybe other database servers
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that picks a database that has pending jobs.
+ *
+ * @ingroup Maintenance
+ */
 class nextJobDB extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/nukeNS.php b/maintenance/nukeNS.php
index 5d4f374c9c..1defe1b2f5 100644
--- a/maintenance/nukeNS.php
+++ b/maintenance/nukeNS.php
@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Remove pages with only 1 revision from the MediaWiki namespace, without
  * flooding recent changes, delete logs, etc.
@@ -28,6 +27,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  * @author Steve Sanbeg
  * based on nukePage by Rob Church
@@ -35,6 +35,12 @@
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that removes pages with only one revision from the
+ * MediaWiki namespace.
+ *
+ * @ingroup Maintenance
+ */
 class NukeNS extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/nukePage.php b/maintenance/nukePage.php
index f63de4369c..3193d4367d 100644
--- a/maintenance/nukePage.php
+++ b/maintenance/nukePage.php
@@ -18,12 +18,18 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  * @author Rob Church <robchur@gmail.com>
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that erases a page record from the database.
+ *
+ * @ingroup Maintenance
+ */
 class NukePage extends Maintenance {
 	public function __construct() {
 		parent::__construct();
diff --git a/maintenance/orphans.php b/maintenance/orphans.php
index faaadd3776..1ab3b9962a 100644
--- a/maintenance/orphans.php
+++ b/maintenance/orphans.php
@@ -1,11 +1,11 @@
 <?php
 /**
- * Look for 'orphan' revisions hooked to pages which don't exist
- * And 'childless' pages with no revisions.
+ * Look for 'orphan' revisions hooked to pages which don't exist and
+ * 'childless' pages with no revisions.
  * Then, kill the poor widows and orphans.
  * Man this is depressing.
  *
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -23,17 +23,24 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @author <brion@pobox.com>
  * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
+/**
+ * Maintenance script that looks for 'orphan' revisions hooked to pages which
+ * don't exist and 'childless' pages with no revisions.
+ *
+ * @ingroup Maintenance
+ */
 class Orphans extends Maintenance {
 	public function __construct() {
 		parent::__construct();
 		$this->mDescription = "Look for 'orphan' revisions hooked to pages which don't exist\n" .
-								"And 'childless' pages with no revisions\n" .
+								"and 'childless' pages with no revisions\n" .
 								"Then, kill the poor widows and orphans\n" .
 								"Man this is depressing";
 		$this->addOption( 'fix', 'Actually fix broken entries' );
-- 
2.20.1