* Added file description headers
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sat, 21 Aug 2010 18:20:09 +0000 (18:20 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sat, 21 Aug 2010 18:20:09 +0000 (18:20 +0000)
* Added @file where needed

17 files changed:
includes/installer/CliInstaller.php
includes/installer/CoreInstaller.php
includes/installer/DatabaseInstaller.php
includes/installer/DatabaseUpdater.php
includes/installer/Installer.i18n.php
includes/installer/Installer.php
includes/installer/LocalSettingsGenerator.php
includes/installer/MysqlInstaller.php
includes/installer/MysqlUpdater.php
includes/installer/OracleInstaller.php
includes/installer/PostgresInstaller.php
includes/installer/PostgresUpdater.php
includes/installer/SqliteInstaller.php
includes/installer/SqliteUpdater.php
includes/installer/WebInstaller.php
includes/installer/WebInstallerOutput.php
includes/installer/WebInstallerPage.php

index 9b356d8..666f835 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Core installer command line interface.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Class for the core installer command line interface.
index 63c7097..681e2c1 100644 (file)
@@ -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
         */
index 67f2479..c7e2719 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * DBMS-specific installation helper.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Base class for DBMS-specific installation helper classes.
index 4af7472..228b758 100644 (file)
@@ -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 :)
index a7fad10..2b2a97e 100644 (file)
@@ -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();
index 2b6565d..ed2ac71 100644 (file)
@@ -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 ) {
index f31e045..645aca1 100644 (file)
@@ -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
index acc2365..44dfa00 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * MySQL-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Class for setting up the MediaWiki database using MySQL.
index 99ef570..9a4c77d 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * MySQL-specific updater.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Mysql update list and mysql-specific update functions.
index 5392368..0abc69f 100644 (file)
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Oracle-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 /**
  * Class for setting up the MediaWiki database using Oracle.
  * 
index 8b3643c..f2e5c76 100644 (file)
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * PostgreSQL-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 /**
  * Class for setting up the MediaWiki database using Postgres.
  * 
index d9d37be..8c27bfe 100644 (file)
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * PostgreSQL-specific updater.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 /**
  * Class for handling updates to Postgres databases.
  *
index b5dfb9c..36301c4 100644 (file)
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Sqlite-specific installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 /**
  * Class for setting up the MediaWiki database using SQLLite.
  * 
index 86624e6..47151fe 100644 (file)
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Sqlite-specific updater.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 /**
  * Class for handling updates to Sqlite databases.
  * 
index 398fdb0..08edf65 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Core installer web interface.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Class for the core installer web interface.
index 2885849..ca58fe3 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Output handler for the web installer.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Output class modelled on OutputPage.
index b3195b2..1e4e1ea 100644 (file)
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Base code for web installer pages.
+ *
+ * @file
+ * @ingroup Deployment
+ */
 
 /**
  * Abstract class to define pages for the web installer.