From b8cafd49788c57ffd150b3de74d3a849f24e9f66 Mon Sep 17 00:00:00 2001
From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Sat, 21 Aug 2010 18:20:09 +0000
Subject: [PATCH] * Added file description headers * Added @file where needed

---
 includes/installer/CliInstaller.php           |  6 ++++++
 includes/installer/CoreInstaller.php          | 12 +++++++++---
 includes/installer/DatabaseInstaller.php      |  6 ++++++
 includes/installer/DatabaseUpdater.php        |  8 +++++++-
 includes/installer/Installer.i18n.php         |  5 ++++-
 includes/installer/Installer.php              |  8 +++++++-
 includes/installer/LocalSettingsGenerator.php |  8 +++++++-
 includes/installer/MysqlInstaller.php         |  6 ++++++
 includes/installer/MysqlUpdater.php           |  6 ++++++
 includes/installer/OracleInstaller.php        |  8 +++++++-
 includes/installer/PostgresInstaller.php      |  8 +++++++-
 includes/installer/PostgresUpdater.php        |  8 +++++++-
 includes/installer/SqliteInstaller.php        |  8 +++++++-
 includes/installer/SqliteUpdater.php          |  8 +++++++-
 includes/installer/WebInstaller.php           |  6 ++++++
 includes/installer/WebInstallerOutput.php     |  6 ++++++
 includes/installer/WebInstallerPage.php       |  6 ++++++
 17 files changed, 111 insertions(+), 12 deletions(-)

diff --git a/includes/installer/CliInstaller.php b/includes/installer/CliInstaller.php
index 9b356d80af..666f835d19 100644
--- a/includes/installer/CliInstaller.php
+++ b/includes/installer/CliInstaller.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Core installer command line interface.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Class for the core installer command line interface.
diff --git a/includes/installer/CoreInstaller.php b/includes/installer/CoreInstaller.php
index 63c70972d2..681e2c15b6 100644
--- a/includes/installer/CoreInstaller.php
+++ b/includes/installer/CoreInstaller.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Base core installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Base core installer class.
@@ -171,7 +177,7 @@ abstract class CoreInstaller extends Installer {
 	/**
 	 * TODO: document
 	 *
-	 * @param Status $status
+	 * @param $status Status
 	 */
 	public abstract function showStatusMessage( Status $status );
 
@@ -307,8 +313,8 @@ abstract class CoreInstaller extends Installer {
 	/**
 	 * Actually perform the installation.
 	 *
-	 * @param Array $startCB A callback array for the beginning of each step
-	 * @param Array $endCB A callback array for the end of each step
+	 * @param $startCB A callback array for the beginning of each step
+	 * @param $endCB A callback array for the end of each step
 	 *
 	 * @return Array of Status objects
 	 */
diff --git a/includes/installer/DatabaseInstaller.php b/includes/installer/DatabaseInstaller.php
index 67f2479b1e..c7e27198f6 100644
--- a/includes/installer/DatabaseInstaller.php
+++ b/includes/installer/DatabaseInstaller.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * DBMS-specific installation helper.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Base class for DBMS-specific installation helper classes.
diff --git a/includes/installer/DatabaseUpdater.php b/includes/installer/DatabaseUpdater.php
index 4af7472ee0..228b75888d 100644
--- a/includes/installer/DatabaseUpdater.php
+++ b/includes/installer/DatabaseUpdater.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * DBMS-specific updater helper.
+ *
+ * @file
+ * @ingroup Deployment
+ */
+ 
 /*
  * Class for handling database updates. Roughly based off of updaters.inc, with
  * a few improvements :)
diff --git a/includes/installer/Installer.i18n.php b/includes/installer/Installer.i18n.php
index a7fad10167..2b2a97e0d8 100644
--- a/includes/installer/Installer.i18n.php
+++ b/includes/installer/Installer.i18n.php
@@ -1,8 +1,11 @@
 <?php
-/*
+/**
  * Internationalization file for the install/upgrade process. None of the
  * messages used here are loaded during normal operations, only during
  * install and upgrade. So you should not put normal messages here.
+ *
+ * @file
+ * @ingroup Deployment
  */
 
 $messages = array();
diff --git a/includes/installer/Installer.php b/includes/installer/Installer.php
index 2b6565dbe5..ed2ac71246 100644
--- a/includes/installer/Installer.php
+++ b/includes/installer/Installer.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Base code for MediaWiki installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * This documentation group collects source code files with deployment functionality.
@@ -804,7 +810,7 @@ abstract class Installer {
 
 	/**
 	 * Convert a hex string representing a Unicode code point to that code point.
-	 * @param string $c
+	 * @param $c String
 	 * @return string
 	 */
 	protected function unicodeChar( $c ) {
diff --git a/includes/installer/LocalSettingsGenerator.php b/includes/installer/LocalSettingsGenerator.php
index f31e0458eb..645aca1cdd 100644
--- a/includes/installer/LocalSettingsGenerator.php
+++ b/includes/installer/LocalSettingsGenerator.php
@@ -1,7 +1,13 @@
 <?php
+/**
+ * Generator for LocalSettings.php file.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
- * Class for manipulating LocalSettings.
+ * Class for generating LocalSettings.php file.
  *
  * @ingroup Deployment
  * @since 1.17
diff --git a/includes/installer/MysqlInstaller.php b/includes/installer/MysqlInstaller.php
index acc2365e35..44dfa00b02 100644
--- a/includes/installer/MysqlInstaller.php
+++ b/includes/installer/MysqlInstaller.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * MySQL-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Class for setting up the MediaWiki database using MySQL.
diff --git a/includes/installer/MysqlUpdater.php b/includes/installer/MysqlUpdater.php
index 99ef5707f0..9a4c77dc94 100644
--- a/includes/installer/MysqlUpdater.php
+++ b/includes/installer/MysqlUpdater.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * MySQL-specific updater.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Mysql update list and mysql-specific update functions.
diff --git a/includes/installer/OracleInstaller.php b/includes/installer/OracleInstaller.php
index 53923686d5..0abc69f146 100644
--- a/includes/installer/OracleInstaller.php
+++ b/includes/installer/OracleInstaller.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Oracle-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
+ 
 /**
  * Class for setting up the MediaWiki database using Oracle.
  * 
diff --git a/includes/installer/PostgresInstaller.php b/includes/installer/PostgresInstaller.php
index 8b3643c76b..f2e5c76117 100644
--- a/includes/installer/PostgresInstaller.php
+++ b/includes/installer/PostgresInstaller.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * PostgreSQL-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
+ 
 /**
  * Class for setting up the MediaWiki database using Postgres.
  * 
diff --git a/includes/installer/PostgresUpdater.php b/includes/installer/PostgresUpdater.php
index d9d37be008..8c27bfe52f 100644
--- a/includes/installer/PostgresUpdater.php
+++ b/includes/installer/PostgresUpdater.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * PostgreSQL-specific updater.
+ *
+ * @file
+ * @ingroup Deployment
+ */
+ 
 /**
  * Class for handling updates to Postgres databases.
  *
diff --git a/includes/installer/SqliteInstaller.php b/includes/installer/SqliteInstaller.php
index b5dfb9cc03..36301c42ee 100644
--- a/includes/installer/SqliteInstaller.php
+++ b/includes/installer/SqliteInstaller.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Sqlite-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
+ 
 /**
  * Class for setting up the MediaWiki database using SQLLite.
  * 
diff --git a/includes/installer/SqliteUpdater.php b/includes/installer/SqliteUpdater.php
index 86624e6f58..47151fe123 100644
--- a/includes/installer/SqliteUpdater.php
+++ b/includes/installer/SqliteUpdater.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Sqlite-specific updater.
+ *
+ * @file
+ * @ingroup Deployment
+ */
+ 
 /**
  * Class for handling updates to Sqlite databases.
  * 
diff --git a/includes/installer/WebInstaller.php b/includes/installer/WebInstaller.php
index 398fdb0cd6..08edf65c58 100644
--- a/includes/installer/WebInstaller.php
+++ b/includes/installer/WebInstaller.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Core installer web interface.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Class for the core installer web interface.
diff --git a/includes/installer/WebInstallerOutput.php b/includes/installer/WebInstallerOutput.php
index 2885849266..ca58fe3cc0 100644
--- a/includes/installer/WebInstallerOutput.php
+++ b/includes/installer/WebInstallerOutput.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Output handler for the web installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Output class modelled on OutputPage.
diff --git a/includes/installer/WebInstallerPage.php b/includes/installer/WebInstallerPage.php
index b3195b24c7..1e4e1ea5e7 100644
--- a/includes/installer/WebInstallerPage.php
+++ b/includes/installer/WebInstallerPage.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Base code for web installer pages.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Abstract class to define pages for the web installer.
-- 
2.20.1