* Standardised file description headers

* added @file where needed
* added file description headers where needed

diff --git a/maintenance/7zip.inc b/maintenance/7zip.inc
index 6acd43b..049bbf1 100644 (file)
--- a/maintenance/7zip.inc
+++ b/maintenance/7zip.inc
@@ -1,4 +1,11 @@
 <?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()

diff --git a/maintenance/attachLatest.php b/maintenance/attachLatest.php
index 6db5d6d..208e9ae 100644 (file)
--- a/maintenance/attachLatest.php
+++ b/maintenance/attachLatest.php
@@ -3,7 +3,7 @@
  * quick hackjob to fix damages imports on wikisource
  * page records have page_latest wrong
  *
- * 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
@@ -21,6 +21,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

diff --git a/maintenance/backup.inc b/maintenance/backup.inc
index 9b2ff89..3506d84 100644 (file)
--- a/maintenance/backup.inc
+++ b/maintenance/backup.inc
@@ -1,6 +1,8 @@
 <?php
 /**
- * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
+ * Base classes for database dumpers
+ *
+ * Copyright © 2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
  *
  * This program is free software; you can redistribute it and/or modify

diff --git a/maintenance/backupPrefetch.inc b/maintenance/backupPrefetch.inc
index c8af6a6..14f78a0 100644 (file)
--- a/maintenance/backupPrefetch.inc
+++ b/maintenance/backupPrefetch.inc
@@ -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

diff --git a/maintenance/benchmarkPurge.php b/maintenance/benchmarkPurge.php
index 77f7083..ca5d05d 100644 (file)
--- a/maintenance/benchmarkPurge.php
+++ b/maintenance/benchmarkPurge.php
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

diff --git a/maintenance/checkAutoLoader.php b/maintenance/checkAutoLoader.php
index 3708979..9dc935e 100644 (file)
--- a/maintenance/checkAutoLoader.php
+++ b/maintenance/checkAutoLoader.php
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

diff --git a/maintenance/checkImages.php b/maintenance/checkImages.php
index e202183..b720b1c 100644 (file)
--- a/maintenance/checkImages.php
+++ b/maintenance/checkImages.php
@@ -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' );

diff --git a/maintenance/checkSyntax.php b/maintenance/checkSyntax.php
index 02b5a69..c0966ae 100644 (file)
--- a/maintenance/checkSyntax.php
+++ b/maintenance/checkSyntax.php
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
  

diff --git a/maintenance/checkUsernames.php b/maintenance/checkUsernames.php
index 4621d85..414d098 100644 (file)
--- a/maintenance/checkUsernames.php
+++ b/maintenance/checkUsernames.php
@@ -19,6 +19,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

diff --git a/maintenance/cleanupCaps.php b/maintenance/cleanupCaps.php
index 250a688..495bfce 100644 (file)
--- a/maintenance/cleanupCaps.php
+++ b/maintenance/cleanupCaps.php
@@ -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 <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
@@ -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' );

diff --git a/maintenance/cleanupImages.php b/maintenance/cleanupImages.php
index 0f4f079..5a19e03 100644 (file)
--- a/maintenance/cleanupImages.php
+++ b/maintenance/cleanupImages.php
@@ -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
  */

diff --git a/maintenance/cleanupSpam.php b/maintenance/cleanupSpam.php
index 2609740..15dd7f7 100644 (file)
--- a/maintenance/cleanupSpam.php
+++ b/maintenance/cleanupSpam.php
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

diff --git a/maintenance/cleanupTable.inc b/maintenance/cleanupTable.inc
index 3b3957a..67a3251 100644 (file)
--- a/maintenance/cleanupTable.inc
+++ b/maintenance/cleanupTable.inc
@@ -17,6 +17,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 

diff --git a/maintenance/cleanupTitles.php b/maintenance/cleanupTitles.php
index fe6a63a..bb7aaa7 100644 (file)
--- a/maintenance/cleanupTitles.php
+++ b/maintenance/cleanupTitles.php
@@ -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 <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
@@ -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
  */

diff --git a/maintenance/cleanupWatchlist.php b/maintenance/cleanupWatchlist.php
index d306778..8c85edf 100644 (file)
--- a/maintenance/cleanupWatchlist.php
+++ b/maintenance/cleanupWatchlist.php
@@ -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
  */