Phpdoc comments and place holder. Part of the subpackage "maintenance", archives...
authorAntoine Musso <hashar@users.mediawiki.org>
Fri, 3 Sep 2004 20:33:01 +0000 (20:33 +0000)
committerAntoine Musso <hashar@users.mediawiki.org>
Fri, 3 Sep 2004 20:33:01 +0000 (20:33 +0000)
46 files changed:
maintenance/DiffLanguage.php
maintenance/InitialiseMessages.inc
maintenance/archives/convertdb.php
maintenance/archives/importTests.php
maintenance/archives/importUseModWiki.php
maintenance/archives/moveCustomMessages.inc
maintenance/archives/moveCustomMessages.php
maintenance/archives/rebuildRecentchanges.inc
maintenance/archives/upgradeWatchlist.php
maintenance/attribute.php
maintenance/checktrans-enhanced.php
maintenance/checktrans.php
maintenance/checktrans2.php
maintenance/cleandb.php
maintenance/commandLine.inc
maintenance/compressOld.inc
maintenance/compressOld.php
maintenance/convertLinks.inc
maintenance/convertLinks.php
maintenance/dumpMessages.php
maintenance/eval.php
maintenance/importLogs.inc
maintenance/importLogs.php
maintenance/importPhase2.php
maintenance/importUseModWiki.php
maintenance/liveCmdLine.inc
maintenance/mcc.php
maintenance/ourusers.php
maintenance/rebuildInterwiki.inc
maintenance/rebuildInterwiki.php
maintenance/rebuildMessages.php
maintenance/rebuildall.php
maintenance/rebuildlinks.inc
maintenance/rebuildlinks.php
maintenance/rebuildrecentchanges.inc
maintenance/rebuildrecentchanges.php
maintenance/rebuildtextindex.inc
maintenance/rebuildtextindex.php
maintenance/refreshLinks.inc
maintenance/refreshLinks.php
maintenance/remove-brokenlinks.php
maintenance/trivialCmdLine.php
maintenance/update2.php
maintenance/updateSearchIndex.inc
maintenance/updateSearchIndex.php
maintenance/updaters.inc

index 59bb36d..bb4dcd6 100644 (file)
@@ -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 */
index 2d6f765..9f8da0d 100755 (executable)
@@ -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;
index 3950fab..240a3c3 100644 (file)
@@ -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
index 6e28379..ec9e6f9 100644 (file)
@@ -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
index 09eb025..755acc1 100644 (file)
@@ -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 ) {
index 0bc6119..2b28de1 100644 (file)
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @deprecated
+ * @package MediaWiki
+ * @subpackage MaintenanceArchive
+ */
 
+/** */
 function isTemplateInitialised() {
        $fname = 'isTemplateInitialised';
 
index 454bc83..ea79bc2 100644 (file)
@@ -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]
 
index fa32e12..54f6cb3 100644 (file)
@@ -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";
index 20914fc..b4605a5 100644 (file)
@@ -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
index 61c43b0..7220a85 100644 (file)
@@ -1,5 +1,12 @@
 <?php
-# Script for re-attributing edits
+/**
+ * Script for re-attributing edits
+ *
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 
 # Parameters
index b8e6b67..2fd4819 100644 (file)
@@ -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";
-
index 2281e43..af8217b 100644 (file)
@@ -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";
-
index 79989bd..c9fb358 100755 (executable)
@@ -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";
-
index ce93c66..dade09e 100644 (file)
@@ -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" );
 
index 72f1f19..fb5a8d8 100644 (file)
@@ -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";
index 249816e..c99eac4 100644 (file)
@@ -1,5 +1,10 @@
 <?php
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 function compressOldPages( $start = 0 ) {
        $fname = 'compressOldPages';
 
index 0d35313..d1f3f06 100644 (file)
@@ -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" );
 
index 62ec7a2..0d75c81 100644 (file)
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 function convertLinks() {
        print "Converting links table to ID-ID...\n";
        
index 3511e40..5939b94 100644 (file)
@@ -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" );
 
index 887e1c5..84ecc4c 100644 (file)
@@ -1,4 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 $wgMessageCache->disableTransform();
 $messages = array();
index 6c59d0c..c53da36 100755 (executable)
@@ -1,4 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 
 do {
@@ -13,4 +20,3 @@ do {
 
 
 ?>
-
index 948c686..c499240 100644 (file)
 # 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
+?>
index 78596c2..00bb662 100644 (file)
@@ -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
+?>
index 76b7809..a3b145e 100644 (file)
 # 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
+?>
index d7416fa..c0a4b24 100644 (file)
@@ -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";
 
index 67d09d1..a3a28ca 100644 (file)
@@ -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();
index 595103e..24ca063 100755 (executable)
@@ -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) );
index 7e62884..be35586 100644 (file)
@@ -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";
 }
-
-
index a8a4d94..0f1f75b 100644 (file)
@@ -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;
 
index 3256bdb..3f786d0 100644 (file)
@@ -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" );
index 0a40f94..e195a72 100755 (executable)
@@ -1,4 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+
+/** */
 require_once( "commandLine.inc" );
 include_once( "InitialiseMessages.inc" );
 
index 487b4a4..91f5492 100644 (file)
@@ -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" );
index 83298d1..12148d6 100644 (file)
@@ -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;
index f47b922..3a004f6 100644 (file)
@@ -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" );
 
index 8d10f56..2d9fc2f 100644 (file)
@@ -1,8 +1,13 @@
 <?php
+/**
+ * Rebuild recent changes table.
+ *
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
-# Rebuild recent changes table.
-#
-
+/** */
 function rebuildRecentChangesTablePass1()
 {
        $fname = 'rebuildRecentChangesTablePass1';
index 6e342b2..1ab2b02 100644 (file)
@@ -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" );
index 04e0eb6..13f4608 100644 (file)
@@ -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 )
index 247fedc..e7c1b02 100644 (file)
@@ -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" );
index 1aac42e..c57acf3 100644 (file)
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 define( "REPORTING_INTERVAL", 50 );
 define( "PAUSE_INTERVAL", 50 );
 
index 6d6ddc3..d319406 100644 (file)
@@ -1,5 +1,11 @@
 <?php
+/**
+ * @todo document
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 require_once( "commandLine.inc" );
 require_once( "refreshLinks.inc" );
 
index 8cdd9ba..d61ff85 100644 (file)
@@ -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" );
index 82f23dd..0aa4f15 100644 (file)
@@ -1,5 +1,10 @@
 <?php
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 require_once( "commandLine.inc" );
 # print "DB name: $wgDBname\n";
 # print "DB user: $wgDBuser\n";
index b871209..2fc6329 100644 (file)
@@ -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" );
index 1344f51..a91cc2b 100644 (file)
@@ -1,5 +1,10 @@
 <?php
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 
+/** */
 function updateSearchIndex( $start, $end, $maxLockTime, $quiet ) {
        global $wgQuiet;
        global $wgDisableSearchUpdate;
index 75b789e..5c655a5 100644 (file)
@@ -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' );
index 5f62dcb..ee64362 100644 (file)
@@ -1,5 +1,10 @@
 <?php
-
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
+ /** */
 function do_revision_updates() {
        global $wgSoftwareRevision;
        if ( $wgSoftwareRevision < 1001 ) {