From 6bbcf091bf4513df95db2783097d90e2a13ceec9 Mon Sep 17 00:00:00 2001
From: Antoine Musso <hashar@users.mediawiki.org>
Date: Fri, 3 Sep 2004 20:33:01 +0000
Subject: [PATCH] Phpdoc comments and place holder. Part of the subpackage
 "maintenance", archives in subpackage "maintenanceArchive"

---
 maintenance/DiffLanguage.php                  |  2 +
 maintenance/InitialiseMessages.inc            | 17 ++++--
 maintenance/archives/convertdb.php            |  6 ++
 maintenance/archives/importTests.php          |  6 ++
 maintenance/archives/importUseModWiki.php     | 14 ++++-
 maintenance/archives/moveCustomMessages.inc   |  6 ++
 maintenance/archives/moveCustomMessages.php   |  8 +++
 maintenance/archives/rebuildRecentchanges.inc | 12 +++-
 maintenance/archives/upgradeWatchlist.php     |  6 ++
 maintenance/attribute.php                     |  9 ++-
 maintenance/checktrans-enhanced.php           | 40 ++++++-------
 maintenance/checktrans.php                    | 19 ++++---
 maintenance/checktrans2.php                   |  7 ++-
 maintenance/cleandb.php                       | 13 +++--
 maintenance/commandLine.inc                   |  6 ++
 maintenance/compressOld.inc                   |  5 ++
 maintenance/compressOld.php                   |  9 ++-
 maintenance/convertLinks.inc                  |  6 ++
 maintenance/convertLinks.php                  | 10 +++-
 maintenance/dumpMessages.php                  |  7 +++
 maintenance/eval.php                          |  8 ++-
 maintenance/importLogs.inc                    | 22 +++++--
 maintenance/importLogs.php                    |  8 ++-
 maintenance/importPhase2.php                  | 20 ++++++-
 maintenance/importUseModWiki.php              | 33 ++++++-----
 maintenance/liveCmdLine.inc                   | 18 ++++--
 maintenance/mcc.php                           | 10 +++-
 maintenance/ourusers.php                      |  9 ++-
 maintenance/rebuildInterwiki.inc              | 18 +++++-
 maintenance/rebuildInterwiki.php              | 10 +++-
 maintenance/rebuildMessages.php               |  7 +++
 maintenance/rebuildall.php                    | 13 +++--
 maintenance/rebuildlinks.inc                  | 57 +++++++++++++------
 maintenance/rebuildlinks.php                  | 13 +++--
 maintenance/rebuildrecentchanges.inc          | 11 +++-
 maintenance/rebuildrecentchanges.php          | 12 +++-
 maintenance/rebuildtextindex.inc              | 20 ++++---
 maintenance/rebuildtextindex.php              | 11 +++-
 maintenance/refreshLinks.inc                  |  6 ++
 maintenance/refreshLinks.php                  |  6 ++
 maintenance/remove-brokenlinks.php            |  7 ++-
 maintenance/trivialCmdLine.php                |  5 ++
 maintenance/update2.php                       |  8 ++-
 maintenance/updateSearchIndex.inc             |  5 ++
 maintenance/updateSearchIndex.php             | 25 ++++----
 maintenance/updaters.inc                      |  7 ++-
 46 files changed, 434 insertions(+), 143 deletions(-)

diff --git a/maintenance/DiffLanguage.php b/maintenance/DiffLanguage.php
index 59bb36dcb9..bb4dcd6f9d 100644
--- a/maintenance/DiffLanguage.php
+++ b/maintenance/DiffLanguage.php
@@ -32,6 +32,8 @@
  * The script then print a list of wgAllMessagesXX keys that aren't
  * localised, a percentage of messages correctly localised and the
  * number of messages to be translated.
+ * @package MediaWiki
+ * @subpackage Maintenance
  */
 
 /** This script run from the commandline */
diff --git a/maintenance/InitialiseMessages.inc b/maintenance/InitialiseMessages.inc
index 2d6f765081..9f8da0d1cc 100755
--- a/maintenance/InitialiseMessages.inc
+++ b/maintenance/InitialiseMessages.inc
@@ -1,9 +1,16 @@
 <?php
-# Script to initialise the MediaWiki namespace
-
-# This script is included from update.php and install.php. Do not run it 
-# by itself.
-
+/**
+ * Script to initialise the MediaWiki namespace
+ *
+ * This script is included from update.php and install.php. Do not run it 
+ * by itself.
+ *
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 function initialiseMessages( $overwrite = false, $messageArray = false ) {
 	global $wgLang, $wgScript, $wgServer, $wgAllMessagesEn;
 	global $wgOut, $wgArticle, $wgUser;
diff --git a/maintenance/archives/convertdb.php b/maintenance/archives/convertdb.php
index 3950fabb08..240a3c3f09 100644
--- a/maintenance/archives/convertdb.php
+++ b/maintenance/archives/convertdb.php
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
 
+/** */
 print "This script is obsolete!";
 print "It is retained in the source here in case some of its
 code might be useful for ad-hoc conversion tasks, but it is
diff --git a/maintenance/archives/importTests.php b/maintenance/archives/importTests.php
index 6e283790db..ec9e6f9bd8 100644
--- a/maintenance/archives/importTests.php
+++ b/maintenance/archives/importTests.php
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
 
+/** */
 print "This script is obsolete!";
 print "It is retained in the source here in case some of its
 code might be useful for ad-hoc conversion tasks, but it is
diff --git a/maintenance/archives/importUseModWiki.php b/maintenance/archives/importUseModWiki.php
index 09eb025f55..755acc1406 100644
--- a/maintenance/archives/importUseModWiki.php
+++ b/maintenance/archives/importUseModWiki.php
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
 
+/** */
 print "This script is obsolete!";
 print "It is retained in the source here in case some of its
 code might be useful for ad-hoc conversion tasks, but it is
@@ -53,7 +59,13 @@ $usercache = array();
 $titlecache = array();
 $linkcache = array();
 
-# Some oversimplified test types
+/**
+ * Some oversimplified test types
+ *
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
 class Title {
 	var $title, $namespace;
 	function fromData( $namespace, $title ) {
diff --git a/maintenance/archives/moveCustomMessages.inc b/maintenance/archives/moveCustomMessages.inc
index 0bc611910c..2b28de1db8 100644
--- a/maintenance/archives/moveCustomMessages.inc
+++ b/maintenance/archives/moveCustomMessages.inc
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
 
+/** */
 function isTemplateInitialised() {
 	$fname = 'isTemplateInitialised';
 
diff --git a/maintenance/archives/moveCustomMessages.php b/maintenance/archives/moveCustomMessages.php
index 454bc83078..ea79bc21a0 100644
--- a/maintenance/archives/moveCustomMessages.php
+++ b/maintenance/archives/moveCustomMessages.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
+
+/** */
+
 # Move "custom messages" from the MediaWiki namespace to the Template namespace
 # Usage: php moveCustomMessages.php [<lang>] [phase]
 
diff --git a/maintenance/archives/rebuildRecentchanges.inc b/maintenance/archives/rebuildRecentchanges.inc
index fa32e12f41..54f6cb38c6 100644
--- a/maintenance/archives/rebuildRecentchanges.inc
+++ b/maintenance/archives/rebuildRecentchanges.inc
@@ -1,7 +1,13 @@
 <?php
-
-# Rebuild recent changes table.
-
+/**
+ * Rebuild recent changes table
+ *
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
+
+/** */
 function rebuildRecentChangesTable()
 {
 	$sql = "DROP TABLE IF EXISTS recentchanges";
diff --git a/maintenance/archives/upgradeWatchlist.php b/maintenance/archives/upgradeWatchlist.php
index 20914fca03..b4605a5007 100644
--- a/maintenance/archives/upgradeWatchlist.php
+++ b/maintenance/archives/upgradeWatchlist.php
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
 
+/** */
 print "This script is obsolete!";
 print "It is retained in the source here in case some of its
 code might be useful for ad-hoc conversion tasks, but it is
diff --git a/maintenance/attribute.php b/maintenance/attribute.php
index 61c43b0898..7220a85734 100644
--- a/maintenance/attribute.php
+++ b/maintenance/attribute.php
@@ -1,5 +1,12 @@
 <?php
-# Script for re-attributing edits
+/**
+ * Script for re-attributing edits
+ *
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 
 # Parameters
diff --git a/maintenance/checktrans-enhanced.php b/maintenance/checktrans-enhanced.php
index b8e6b67891..2fd481912e 100644
--- a/maintenance/checktrans-enhanced.php
+++ b/maintenance/checktrans-enhanced.php
@@ -1,17 +1,20 @@
 <?php
-
-# Check to see if all messages have been translated into
-# the selected language. To run this script, you must have
-# a working installation, and it checks the selected language
-# of that installation.
-#
-# The enhanced version will check more arrays than just
-# wgAllMessages
-
-
-
-function check($arrayname)
-{
+/**
+ * Check to see if all messages have been translated into
+ * the selected language. To run this script, you must have
+ * a working installation, and it checks the selected language
+ * of that installation.
+ *
+ * The enhanced version will check more arrays than just
+ * wgAllMessages
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
+function check($arrayname) {
 	$arraynameprinted = 0;
 	
 	global $count, $total, $wgLanguageCode;
@@ -37,11 +40,6 @@ function check($arrayname)
 	}
 }
 
-
-
-
-
-
 if ( ! is_readable( "../LocalSettings.php" ) ) {
 	print "A copy of your installation's LocalSettings.php\n" .
 	  "must exist in the source directory.\n";
@@ -72,11 +70,6 @@ $wgCommandLineMode = true;
 $count = $total = 0;
 
 
-
-
-
-
-
 check("wgLanguageNames");
 check("wgNamespaceNames");
 check("wgDefaultUserOptions");
@@ -93,4 +86,3 @@ check("wgDeveloperSpecialPages");
 check("wgAllMessages");
 
 print "{$count} messages of {$total} not translated.\n";
-
diff --git a/maintenance/checktrans.php b/maintenance/checktrans.php
index 2281e4331e..af8217bd09 100644
--- a/maintenance/checktrans.php
+++ b/maintenance/checktrans.php
@@ -1,11 +1,15 @@
 <?php
-
-# Check to see if all messages have been translated into
-# the selected language. To run this script, you must have
-# a working installation, and it checks the selected language
-# of that installation.
-#
-
+/**
+ * Check to see if all messages have been translated into
+ * the selected language. To run this script, you must have
+ * a working installation, and it checks the selected language
+ * of that installation.
+ *
+ * @package MediaWiki
+ * @subpackage Maintenance
+*/
+
+/** */
 if ( ! is_readable( "../LocalSettings.php" ) ) {
 	print "A copy of your installation's LocalSettings.php\n" .
 	  "must exist in the source directory.\n";
@@ -45,4 +49,3 @@ foreach ( $wgAllMessagesEn as $code => $msg ) {
 	}
 }
 print "{$count} messages of {$total} not translated.\n";
-
diff --git a/maintenance/checktrans2.php b/maintenance/checktrans2.php
index 79989bd24f..c9fb3587d7 100755
--- a/maintenance/checktrans2.php
+++ b/maintenance/checktrans2.php
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 die("This script is not being maintained.");
 
 # Checks translation of all language files
@@ -104,4 +110,3 @@ foreach ( $filenames as $filename ) {
 
 print "\n" . str_repeat( "-", $width ) . "\n";
 print "{$count} messages of {$total} not translated.\n";
-
diff --git a/maintenance/cleandb.php b/maintenance/cleandb.php
index ce93c6625e..dade09e493 100644
--- a/maintenance/cleandb.php
+++ b/maintenance/cleandb.php
@@ -1,8 +1,13 @@
 <?php
-
-# Creating a new empty database; either this or the conversion
-# script from the old format needs to be run, but not both.
-
+/**
+ * Creating a new empty database; either this or the conversion
+ * script from the old format needs to be run, but not both.
+ *
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 $wgCommandLineMode = true;
 require_once( "../LocalSettings.php" );
 
diff --git a/maintenance/commandLine.inc b/maintenance/commandLine.inc
index 72f1f19eb6..fb5a8d8a58 100644
--- a/maintenance/commandLine.inc
+++ b/maintenance/commandLine.inc
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 # Abort if called from a web server
 if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
 	print "This script must be run from the command line\n";
diff --git a/maintenance/compressOld.inc b/maintenance/compressOld.inc
index 249816eaa2..c99eac4e22 100644
--- a/maintenance/compressOld.inc
+++ b/maintenance/compressOld.inc
@@ -1,5 +1,10 @@
 <?php
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 function compressOldPages( $start = 0 ) {
 	$fname = 'compressOldPages';
 
diff --git a/maintenance/compressOld.php b/maintenance/compressOld.php
index 0d3531376e..d1f3f066c6 100644
--- a/maintenance/compressOld.php
+++ b/maintenance/compressOld.php
@@ -1,7 +1,12 @@
 <?php
+/**
+ * Compress the old table, old_flags=gzip
+ *
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
-# Compress the old table, old_flags=gzip
-
+/** */
 require_once( "commandLine.inc" );
 require_once( "compressOld.inc" );
 
diff --git a/maintenance/convertLinks.inc b/maintenance/convertLinks.inc
index 62ec7a2412..0d75c81384 100644
--- a/maintenance/convertLinks.inc
+++ b/maintenance/convertLinks.inc
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 function convertLinks() {
 	print "Converting links table to ID-ID...\n";
 	
diff --git a/maintenance/convertLinks.php b/maintenance/convertLinks.php
index 3511e407d5..5939b943b0 100644
--- a/maintenance/convertLinks.php
+++ b/maintenance/convertLinks.php
@@ -1,7 +1,13 @@
 <?php
-# Convert from the old links schema (string->ID) to the new schema (ID->ID)
-# The wiki should be put into read-only mode while this script executes
+/**
+ * Convert from the old links schema (string->ID) to the new schema (ID->ID)
+ * The wiki should be put into read-only mode while this script executes
+ *
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 require_once( "commandLine.inc" );
 require_once( "convertLinks.inc" );
 
diff --git a/maintenance/dumpMessages.php b/maintenance/dumpMessages.php
index 887e1c5a29..84ecc4c6d4 100644
--- a/maintenance/dumpMessages.php
+++ b/maintenance/dumpMessages.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 $wgMessageCache->disableTransform();
 $messages = array();
diff --git a/maintenance/eval.php b/maintenance/eval.php
index 6c59d0c38c..c53da36f90 100755
--- a/maintenance/eval.php
+++ b/maintenance/eval.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 
 do {
@@ -13,4 +20,3 @@ do {
 
 
 ?>
-
diff --git a/maintenance/importLogs.inc b/maintenance/importLogs.inc
index 948c686aab..c499240e32 100644
--- a/maintenance/importLogs.inc
+++ b/maintenance/importLogs.inc
@@ -17,16 +17,28 @@
 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 # http://www.gnu.org/copyleft/gpl.html
 
-# Attempt to import existing log pages into the log tables.
-
-# Not yet complete.
+/**
+ * Attempt to import existing log pages into the log tables.
+ *
+ * Not yet complete.
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 require_once( 'GlobalFunctions.php' );
 require_once( 'Database.php' );
 require_once( 'Article.php' );
 require_once( 'LogPage.php' );
 
-# Log importer
+/**
+ * Log importer
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 class LogImporter {
 	var $dummy = false;
 	
@@ -129,4 +141,4 @@ function wfUnescapeWikiText( $text ) {
 	return $text;
 }
 
-?>
\ No newline at end of file
+?>
diff --git a/maintenance/importLogs.php b/maintenance/importLogs.php
index 78596c2f26..00bb662afb 100644
--- a/maintenance/importLogs.php
+++ b/maintenance/importLogs.php
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 require_once( "commandLine.inc" );
 require_once( "importLogs.inc" );
 
@@ -18,4 +24,4 @@ foreach( LogPage::validTypes() as $type ) {
 	$importer->importText( $text );
 }
 
-?>
\ No newline at end of file
+?>
diff --git a/maintenance/importPhase2.php b/maintenance/importPhase2.php
index 76b78090b7..a3b145ec42 100644
--- a/maintenance/importPhase2.php
+++ b/maintenance/importPhase2.php
@@ -21,6 +21,14 @@
 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 # http://www.gnu.org/copyleft/gpl.html
 
+/**
+ * @todo document
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 die( "This import script is not currently maintained.
 If you need it you'll have to modify it as necessary.\n");
 
@@ -51,6 +59,11 @@ require_once( "rebuildlinks.inc" );
 require_once( "rebuildrecentchanges.inc" );
 require_once( "rebuildtextindex.inc" );
 
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 class Phase2Importer {
 	var $olddb, $titleCache;
 	
@@ -309,6 +322,11 @@ class Phase2Importer {
 	
 }
 
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 class TitleCache {
 	var $hash = array();
 	
@@ -349,4 +367,4 @@ $wgTitle = Title::newFromText( "Conversion script" );
 $importer = new Phase2Importer( $olddb );
 $importer->importAll();
 
-?>
\ No newline at end of file
+?>
diff --git a/maintenance/importUseModWiki.php b/maintenance/importUseModWiki.php
index d7416fabd8..c0a4b24df5 100644
--- a/maintenance/importUseModWiki.php
+++ b/maintenance/importUseModWiki.php
@@ -1,20 +1,23 @@
 <?php
 
-/*
-	Import data from a UseModWiki into a PediaWiki wiki
-	2003-02-09 Brion VIBBER <brion@pobox.com>
-	Based loosely on Magnus's code from 2001-2002
-
-	  Updated limited version to get something working temporarily
-	  2003-10-09
-	  Be sure to run the link & index rebuilding scripts!
-	  
-	  Some more munging for charsets etc
-	  2003-11-28
-
-  */
-
-/* Set these correctly! */
+/**
+ * Import data from a UseModWiki into a PediaWiki wiki
+ * 2003-02-09 Brion VIBBER <brion@pobox.com>
+ * Based loosely on Magnus's code from 2001-2002
+ *
+ * Updated limited version to get something working temporarily
+ * 2003-10-09
+ * Be sure to run the link & index rebuilding scripts!
+ *
+ * Some more munging for charsets etc
+ * 2003-11-28
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** Set these correctly! */
 $wgImportEncoding = "CP1252"; /* We convert all to UTF-8 */
 $wgRootDirectory = "/home/usemod/wiki-ia/lib-http/db/wiki";
 
diff --git a/maintenance/liveCmdLine.inc b/maintenance/liveCmdLine.inc
index 67d09d19c2..a3a28cadeb 100644
--- a/maintenance/liveCmdLine.inc
+++ b/maintenance/liveCmdLine.inc
@@ -1,10 +1,16 @@
 <?php
-
-# This is a drop-in replacement for commandLine.inc, for use only on
-# the Wikimedia wikis.
-# Call your command-line script with the language name and site name,
-# e.g. php convertLinks.php aa wikipedia
-
+/**
+ * This is a drop-in replacement for commandLine.inc, for use only on
+ * the Wikimedia wikis.
+ * Call your command-line script with the language name and site name,
+ * e.g. php convertLinks.php aa wikipedia
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
 	print "This script must be run from the command line\n";
 	exit();
diff --git a/maintenance/mcc.php b/maintenance/mcc.php
index 595103e672..24ca063ad8 100755
--- a/maintenance/mcc.php
+++ b/maintenance/mcc.php
@@ -1,7 +1,13 @@
 <?php
+/**
+ * memcached diagnostic tool
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
-# memcached diagnostic tool
-
+/** */
 require_once( "commandLine.inc" );
 
 $mcc = new memcached( array('persistant' => true) );
diff --git a/maintenance/ourusers.php b/maintenance/ourusers.php
index 7e62884473..be35586dd6 100644
--- a/maintenance/ourusers.php
+++ b/maintenance/ourusers.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 $wikiuser_pass = `wikiuser_pass`;
 $wikiadmin_pass = `wikiadmin_pass`;
 $wikisql_pass = `wikisql_pass`;
@@ -67,5 +74,3 @@ EOS;
 	}
 	print "\n";
 }
-
-
diff --git a/maintenance/rebuildInterwiki.inc b/maintenance/rebuildInterwiki.inc
index a8a4d94323..0f1f75bef5 100644
--- a/maintenance/rebuildInterwiki.inc
+++ b/maintenance/rebuildInterwiki.inc
@@ -1,12 +1,24 @@
 <?php
-
-# Rebuild interwiki table using the file on meta and the language list
-# Wikimedia specific!
+/**
+ * Rebuild interwiki table using the file on meta and the language list
+ * Wikimedia specific!
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 $oldCwd = getcwd();
 
 $optionsWithArgs = array( "o" );
 include_once( "commandLine.inc" );
 
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 class Site {
 	var $suffix, $lateral, $url;
 
diff --git a/maintenance/rebuildInterwiki.php b/maintenance/rebuildInterwiki.php
index 3256bdbfc3..3f786d074a 100644
--- a/maintenance/rebuildInterwiki.php
+++ b/maintenance/rebuildInterwiki.php
@@ -1,7 +1,13 @@
 <?php
+/**
+ * Rebuild interwiki table using the file on meta and the language list
+ * Wikimedia specific!
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
-# Rebuild interwiki table using the file on meta and the language list
-# Wikimedia specific!
+/** */
 $oldCwd = getcwd();
 
 $optionsWithArgs = array( "o" );
diff --git a/maintenance/rebuildMessages.php b/maintenance/rebuildMessages.php
index 0a40f949dc..e195a72418 100755
--- a/maintenance/rebuildMessages.php
+++ b/maintenance/rebuildMessages.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 include_once( "InitialiseMessages.inc" );
 
diff --git a/maintenance/rebuildall.php b/maintenance/rebuildall.php
index 487b4a4417..91f5492c0a 100644
--- a/maintenance/rebuildall.php
+++ b/maintenance/rebuildall.php
@@ -1,8 +1,13 @@
 <?php
-
-# Rebuild link tracking tables from scratch.  This takes several
-# hours, depending on the database size and server configuration.
-
+/**
+ * Rebuild link tracking tables from scratch.  This takes several
+ * hours, depending on the database size and server configuration.
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 
 #require_once( "rebuildlinks.inc" );
diff --git a/maintenance/rebuildlinks.inc b/maintenance/rebuildlinks.inc
index 83298d1add..12148d6b23 100644
--- a/maintenance/rebuildlinks.inc
+++ b/maintenance/rebuildlinks.inc
@@ -1,10 +1,18 @@
 <?php
-
+/**
+ * Functions for rebuilding the link tracking tables; must
+ * be included within a script that also includes the Setup.
+ * See @see rebuildlinks.php, for example.
+ *
+ * @deprecated
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 die( "rebuildLinks.inc needs to be updated for the new schema\n" );
 
-# Functions for rebuilding the link tracking tables; must
-# be included within a script that also includes the Setup.
-# See rebuildlinks.php, for example.
 #
 
 # Buffer this many rows before inserting them all in one sweep. More
@@ -238,13 +246,18 @@ function rebuildLinkTables()
 	return intval($n/$t);
 }
 
-# InsertBuffer increases performance slightly by inserting many rows
-# at once. The gain is small (<5%) when running against a local, idle
-# database, but may be significant in other circumstances. It also
-# limits the number of inserted rows uppwards, which should avoid
-# problems with huge articles and certain mysql settings that limits
-# the size of queries. It's also convenient.
-
+/**
+ * InsertBuffer increases performance slightly by inserting many rows
+ * at once. The gain is small (<5%) when running against a local, idle
+ * database, but may be significant in other circumstances. It also
+ * limits the number of inserted rows uppwards, which should avoid
+ * problems with huge articles and certain mysql settings that limits
+ * the size of queries. It's also convenient.
+ *
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 class InsertBuffer {
 	/* private */ var $mBuf, $mSql, $mBufcount, $mMaxsize;
 	
@@ -276,10 +289,15 @@ class InsertBuffer {
 	
 }
 
-# Select parts from a large table by using the "BETWEEN X AND Y"
-# operator on the id column. Avoids buffering the whole thing in
-# RAM. It's also convenient.  
-
+/**
+ * Select parts from a large table by using the "BETWEEN X AND Y"
+ * operator on the id column. Avoids buffering the whole thing in
+ * RAM. It's also convenient.
+ *
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 class SelectPulser {
 	/* private */ var $mSql, $mSetsize, $mPos, $mMax, $mSet;
 
@@ -316,8 +334,13 @@ class SelectPulser {
 	}
 }
 
-# A simple MRU for general cacheing.
-
+/**
+ * A simple MRU for general cacheing.
+ * @deprecated
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 class MRUCache {
 	/* private */ var $mMru, $mCache, $mSize, $mPurgefreq, $nexti;
 	/* private */ var $hits, $misses;
diff --git a/maintenance/rebuildlinks.php b/maintenance/rebuildlinks.php
index f47b922dbe..3a004f68ad 100644
--- a/maintenance/rebuildlinks.php
+++ b/maintenance/rebuildlinks.php
@@ -1,8 +1,13 @@
 <?php
-
-# Rebuild link tracking tables from scratch.  This takes several
-# hours, depending on the database size and server configuration.
-
+/**
+ * Rebuild link tracking tables from scratch.  This takes several
+ * hours, depending on the database size and server configuration.
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+/** */
 require_once( "commandLine.inc" );
 require_once( "./rebuildlinks.inc" );
 
diff --git a/maintenance/rebuildrecentchanges.inc b/maintenance/rebuildrecentchanges.inc
index 8d10f56f51..2d9fc2f072 100644
--- a/maintenance/rebuildrecentchanges.inc
+++ b/maintenance/rebuildrecentchanges.inc
@@ -1,8 +1,13 @@
 <?php
+/**
+ * Rebuild recent changes table.
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
-# Rebuild recent changes table.
-#
-
+/** */
 function rebuildRecentChangesTablePass1()
 {
 	$fname = 'rebuildRecentChangesTablePass1';
diff --git a/maintenance/rebuildrecentchanges.php b/maintenance/rebuildrecentchanges.php
index 6e342b2b16..1ab2b02434 100644
--- a/maintenance/rebuildrecentchanges.php
+++ b/maintenance/rebuildrecentchanges.php
@@ -1,8 +1,14 @@
 <?php
+/**
+ * Rebuild link tracking tables from scratch.  This takes several
+ * hours, depending on the database size and server configuration.
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
-# Rebuild link tracking tables from scratch.  This takes several
-# hours, depending on the database size and server configuration.
-
+/** */
 require_once( "commandLine.inc" );
 require_once( "./rebuildrecentchanges.inc" );
 $wgTitle = Title::newFromText( "Rebuild recent changes script" );
diff --git a/maintenance/rebuildtextindex.inc b/maintenance/rebuildtextindex.inc
index 04e0eb6fca..13f4608127 100644
--- a/maintenance/rebuildtextindex.inc
+++ b/maintenance/rebuildtextindex.inc
@@ -1,11 +1,17 @@
 <?php
-
-# Rebuild the fulltext search indexes. This may take a while
-# depending on the database size and server configuration.
-
-# Rebuilding is faster if you drop the index and recreate it,
-# but that will prevent searches from working while it runs.
-
+/**
+ * Rebuild the fulltext search indexes. This may take a while
+ * depending on the database size and server configuration.
+ *
+ * Rebuilding is faster if you drop the index and recreate it,
+ * but that will prevent searches from working while it runs.
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 define( "RTI_CHUNK_SIZE", 500 );
 
 function dropTextIndex( &$database )
diff --git a/maintenance/rebuildtextindex.php b/maintenance/rebuildtextindex.php
index 247fedc523..e7c1b023d7 100644
--- a/maintenance/rebuildtextindex.php
+++ b/maintenance/rebuildtextindex.php
@@ -1,7 +1,14 @@
 <?php
-# Rebuild search index table from scratch.  This takes several
-# hours, depending on the database size and server configuration.
+/**
+ * Rebuild search index table from scratch.  This takes several
+ * hours, depending on the database size and server configuration.
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */ 
 
+/** */
 require_once( "commandLine.inc" );
 require_once( "rebuildtextindex.inc" );
 $wgTitle = Title::newFromText( "Rebuild text index script" );
diff --git a/maintenance/refreshLinks.inc b/maintenance/refreshLinks.inc
index 1aac42ec15..c57acf3ef4 100644
--- a/maintenance/refreshLinks.inc
+++ b/maintenance/refreshLinks.inc
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 define( "REPORTING_INTERVAL", 50 );
 define( "PAUSE_INTERVAL", 50 );
 
diff --git a/maintenance/refreshLinks.php b/maintenance/refreshLinks.php
index 6d6ddc3f04..d31940681e 100644
--- a/maintenance/refreshLinks.php
+++ b/maintenance/refreshLinks.php
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 require_once( "commandLine.inc" );
 require_once( "refreshLinks.inc" );
 
diff --git a/maintenance/remove-brokenlinks.php b/maintenance/remove-brokenlinks.php
index 8cdd9bac3c..d61ff85229 100644
--- a/maintenance/remove-brokenlinks.php
+++ b/maintenance/remove-brokenlinks.php
@@ -1,6 +1,11 @@
 <?php
+/**
+ * Remove spurious brokenlinks
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
-# Remove spurious brokenlinks
+/** */
 require_once( "commandLine.inc" );
 require_once( "./rebuildrecentchanges.inc" );
 $wgTitle = Title::newFromText( "Rebuild brokenlinks script" );
diff --git a/maintenance/trivialCmdLine.php b/maintenance/trivialCmdLine.php
index 82f23dd4a5..0aa4f1517c 100644
--- a/maintenance/trivialCmdLine.php
+++ b/maintenance/trivialCmdLine.php
@@ -1,5 +1,10 @@
 <?php
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 require_once( "commandLine.inc" );
 # print "DB name: $wgDBname\n";
 # print "DB user: $wgDBuser\n";
diff --git a/maintenance/update2.php b/maintenance/update2.php
index b8712091cd..2fc6329cb7 100644
--- a/maintenance/update2.php
+++ b/maintenance/update2.php
@@ -1,7 +1,11 @@
 <?php
+/**
+ * This script was used to convert the live Wikimedia wikis from 1.2 to 1.3
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
-# This script was used to convert the live Wikimedia wikis from 1.2 to 1.3
-
+/** */
 $maintenance = "/home/wikipedia/common/php-new/maintenance";
 require_once( "$maintenance/liveCmdLine.inc" );
 require_once( "$maintenance/InitialiseMessages.inc" );
diff --git a/maintenance/updateSearchIndex.inc b/maintenance/updateSearchIndex.inc
index 1344f51967..a91cc2b969 100644
--- a/maintenance/updateSearchIndex.inc
+++ b/maintenance/updateSearchIndex.inc
@@ -1,5 +1,10 @@
 <?php
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 function updateSearchIndex( $start, $end, $maxLockTime, $quiet ) {
 	global $wgQuiet;
 	global $wgDisableSearchUpdate;
diff --git a/maintenance/updateSearchIndex.php b/maintenance/updateSearchIndex.php
index 75b789e785..5c655a551a 100644
--- a/maintenance/updateSearchIndex.php
+++ b/maintenance/updateSearchIndex.php
@@ -1,14 +1,19 @@
 <?php
-
-# Script for periodic off-peak updating of the search index
-
-# Usage: php updateSearchIndex.php [-s START] [-e END] [-p POSFILE] [-l LOCKTIME] [-q]
-# Where START is the starting timestamp
-# END is the ending timestamp
-# POSFILE is a file to load timestamps from and save them to, searchUpdate.pos by default
-# LOCKTIME is how long the searchindex and cur tables will be locked for
-# -q means quiet
-
+/**
+ * Script for periodic off-peak updating of the search index
+ *
+ * Usage: php updateSearchIndex.php [-s START] [-e END] [-p POSFILE] [-l LOCKTIME] [-q]
+ * Where START is the starting timestamp
+ * END is the ending timestamp
+ * POSFILE is a file to load timestamps from and save them to, searchUpdate.pos by default
+ * LOCKTIME is how long the searchindex and cur tables will be locked for
+ * -q means quiet
+ *
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 $optionsWithArgs = array( 's', 'e', 'p' );
 
 require_once( 'commandLine.inc' );
diff --git a/maintenance/updaters.inc b/maintenance/updaters.inc
index 5f62dcb8d2..ee64362eb0 100644
--- a/maintenance/updaters.inc
+++ b/maintenance/updaters.inc
@@ -1,5 +1,10 @@
 <?php
-
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+ 
+ /** */
 function do_revision_updates() {
 	global $wgSoftwareRevision;
 	if ( $wgSoftwareRevision < 1001 ) {
-- 
2.20.1