http://www.mediawiki.org/wiki/Special:Code/MediaWiki/72421

Revision: 72421
Author:   ialex
Date:     2010-09-05 13:15:48 +0000 (Sun, 05 Sep 2010)

Log Message:
-----------
* Standardised file description headers
* added @file where needed
* added file description headers where needed

Modified Paths:
--------------
    trunk/phase3/maintenance/7zip.inc
    trunk/phase3/maintenance/attachLatest.php
    trunk/phase3/maintenance/backup.inc
    trunk/phase3/maintenance/backupPrefetch.inc
    trunk/phase3/maintenance/benchmarkPurge.php
    trunk/phase3/maintenance/checkAutoLoader.php
    trunk/phase3/maintenance/checkImages.php
    trunk/phase3/maintenance/checkSyntax.php
    trunk/phase3/maintenance/checkUsernames.php
    trunk/phase3/maintenance/cleanupCaps.php
    trunk/phase3/maintenance/cleanupImages.php
    trunk/phase3/maintenance/cleanupSpam.php
    trunk/phase3/maintenance/cleanupTable.inc
    trunk/phase3/maintenance/cleanupTitles.php
    trunk/phase3/maintenance/cleanupWatchlist.php

Modified: trunk/phase3/maintenance/7zip.inc
===================================================================
--- trunk/phase3/maintenance/7zip.inc   2010-09-05 13:09:32 UTC (rev 72420)
+++ trunk/phase3/maintenance/7zip.inc   2010-09-05 13:15:48 UTC (rev 72421)
@@ -1,5 +1,12 @@
 <?php
 /**
+ * 7z stream wrapper
+ *
+ * @file
+ * @ingroup Maintenance
+ */
+
+/**
  * Stream wrapper around 7za filter program.
  * Required since we can't pass an open file resource to XMLReader->open()
  * which is used for the text prefetch.

Modified: trunk/phase3/maintenance/attachLatest.php
===================================================================
--- trunk/phase3/maintenance/attachLatest.php   2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/attachLatest.php   2010-09-05 13:15:48 UTC (rev 
72421)
@@ -3,7 +3,7 @@
  * quick hackjob to fix damages imports on wikisource
  * page records have page_latest wrong
  *
- * Copyright (C) 2005 Brion Vibber <[email protected]>
+ * Copyright © 2005 Brion Vibber <[email protected]>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -21,6 +21,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

Modified: trunk/phase3/maintenance/backup.inc
===================================================================
--- trunk/phase3/maintenance/backup.inc 2010-09-05 13:09:32 UTC (rev 72420)
+++ trunk/phase3/maintenance/backup.inc 2010-09-05 13:15:48 UTC (rev 72421)
@@ -1,6 +1,8 @@
 <?php
 /**
- * Copyright (C) 2005 Brion Vibber <[email protected]>
+ * Base classes for database dumpers
+ *
+ * Copyright © 2005 Brion Vibber <[email protected]>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify

Modified: trunk/phase3/maintenance/backupPrefetch.inc
===================================================================
--- trunk/phase3/maintenance/backupPrefetch.inc 2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/backupPrefetch.inc 2010-09-05 13:15:48 UTC (rev 
72421)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Helper class for the --prefetch option of dumpTextPass.php
+ *
+ * @file
+ * @ingrouo Maintenance
+ */
 
 // Some smart guy removed XMLReader's global constants from PHP 5.1
 // and replaced them with class constants. Breaking source compatibility

Modified: trunk/phase3/maintenance/benchmarkPurge.php
===================================================================
--- trunk/phase3/maintenance/benchmarkPurge.php 2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/benchmarkPurge.php 2010-09-05 13:15:48 UTC (rev 
72421)
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

Modified: trunk/phase3/maintenance/checkAutoLoader.php
===================================================================
--- trunk/phase3/maintenance/checkAutoLoader.php        2010-09-05 13:09:32 UTC 
(rev 72420)
+++ trunk/phase3/maintenance/checkAutoLoader.php        2010-09-05 13:15:48 UTC 
(rev 72421)
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

Modified: trunk/phase3/maintenance/checkImages.php
===================================================================
--- trunk/phase3/maintenance/checkImages.php    2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/checkImages.php    2010-09-05 13:15:48 UTC (rev 
72421)
@@ -17,6 +17,7 @@
  * 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' );

Modified: trunk/phase3/maintenance/checkSyntax.php
===================================================================
--- trunk/phase3/maintenance/checkSyntax.php    2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/checkSyntax.php    2010-09-05 13:15:48 UTC (rev 
72421)
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
  

Modified: trunk/phase3/maintenance/checkUsernames.php
===================================================================
--- trunk/phase3/maintenance/checkUsernames.php 2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/checkUsernames.php 2010-09-05 13:15:48 UTC (rev 
72421)
@@ -19,6 +19,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

Modified: trunk/phase3/maintenance/cleanupCaps.php
===================================================================
--- trunk/phase3/maintenance/cleanupCaps.php    2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/cleanupCaps.php    2010-09-05 13:15:48 UTC (rev 
72421)
@@ -1,12 +1,12 @@
 <?php
-/*
+/**
  * Script to clean up broken page links when somebody turns on $wgCapitalLinks.
  *
  * Usage: php cleanupCaps.php [--dry-run]
  * Options:
  *   --dry-run  don't actually try moving them
  *
- * Copyright (C) 2005 Brion Vibber <[email protected]>
+ * Copyright © 2005 Brion Vibber <[email protected]>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -24,8 +24,9 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @author Brion Vibber <brion at pobox.com>
- * @ingroup maintenance
+ * @ingroup Maintenance
  */
 
 require_once( dirname( __FILE__ ) . '/cleanupTable.inc' );

Modified: trunk/phase3/maintenance/cleanupImages.php
===================================================================
--- trunk/phase3/maintenance/cleanupImages.php  2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/cleanupImages.php  2010-09-05 13:15:48 UTC (rev 
72421)
@@ -1,5 +1,5 @@
 <?php
-/*
+/**
  * Script to clean up broken, unparseable upload filenames.
  *
  * Usage: php cleanupImages.php [--fix]
@@ -24,6 +24,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @author Brion Vibber <brion at pobox.com>
  * @ingroup Maintenance
  */

Modified: trunk/phase3/maintenance/cleanupSpam.php
===================================================================
--- trunk/phase3/maintenance/cleanupSpam.php    2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/cleanupSpam.php    2010-09-05 13:15:48 UTC (rev 
72421)
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

Modified: trunk/phase3/maintenance/cleanupTable.inc
===================================================================
--- trunk/phase3/maintenance/cleanupTable.inc   2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/cleanupTable.inc   2010-09-05 13:15:48 UTC (rev 
72421)
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

Modified: trunk/phase3/maintenance/cleanupTitles.php
===================================================================
--- trunk/phase3/maintenance/cleanupTitles.php  2010-09-05 13:09:32 UTC (rev 
72420)
+++ trunk/phase3/maintenance/cleanupTitles.php  2010-09-05 13:15:48 UTC (rev 
72421)
@@ -1,12 +1,12 @@
 <?php
-/*
+/**
  * Script to clean up broken, unparseable titles.
  *
  * Usage: php cleanupTitles.php [--fix]
  * Options:
  *   --fix  Actually clean up titles; otherwise just checks for them
  *
- * Copyright (C) 2005 Brion Vibber <[email protected]>
+ * Copyright © 2005 Brion Vibber <[email protected]>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify
@@ -24,6 +24,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @author Brion Vibber <brion at pobox.com>
  * @ingroup Maintenance
  */

Modified: trunk/phase3/maintenance/cleanupWatchlist.php
===================================================================
--- trunk/phase3/maintenance/cleanupWatchlist.php       2010-09-05 13:09:32 UTC 
(rev 72420)
+++ trunk/phase3/maintenance/cleanupWatchlist.php       2010-09-05 13:15:48 UTC 
(rev 72421)
@@ -1,5 +1,5 @@
 <?php
-/*
+/**
  * Script to remove broken, unparseable titles in the Watchlist.
  *
  * Usage: php cleanupWatchlist.php [--fix]
@@ -24,6 +24,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @author Brion Vibber <brion at pobox.com>
  * @ingroup Maintenance
  */



_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs

Reply via email to