Added deployment documentation group

diff --git a/includes/installer/CliInstaller.php b/includes/installer/CliInstaller.php
index a785977..56602b5 100644 (file)
--- a/includes/installer/CliInstaller.php
+++ b/includes/installer/CliInstaller.php
@@ -3,6 +3,7 @@
 /**
  * Class for the core installer command line interface.
  * 
+ * @ingroup Deployment
  * @since 1.17
  */
 class CliInstaller extends CoreInstaller {

diff --git a/includes/installer/CoreInstaller.php b/includes/installer/CoreInstaller.php
index 09b6d1b..5297d19 100644 (file)
--- a/includes/installer/CoreInstaller.php
+++ b/includes/installer/CoreInstaller.php
@@ -4,6 +4,7 @@
  * Base core installer class.
  * Handles everything that is independent of user interface.
  * 
+ * @ingroup Deployment
  * @since 1.17
  */
 abstract class CoreInstaller extends Installer {

diff --git a/includes/installer/DatabaseInstaller.php b/includes/installer/DatabaseInstaller.php
index acf0e68..456e8e5 100644 (file)
--- a/includes/installer/DatabaseInstaller.php
+++ b/includes/installer/DatabaseInstaller.php
@@ -2,6 +2,9 @@
 
 /**
  * Base class for DBMS-specific installation helper classes.
+ * 
+ * @ingroup Deployment
+ * @since 1.17
  */
 abstract class DatabaseInstaller {
        

diff --git a/includes/installer/DatabaseUpdater.php b/includes/installer/DatabaseUpdater.php
index c817f80..d090f85 100644 (file)
--- a/includes/installer/DatabaseUpdater.php
+++ b/includes/installer/DatabaseUpdater.php
@@ -3,6 +3,9 @@
 /*
  * Class for handling database updates. Roughly based off of updaters.inc, with
  * a few improvements :)
+ * 
+ * @ingroup Deployment
+ * @since 1.17
  */
 abstract class DatabaseUpdater {
 

diff --git a/includes/installer/Installer.php b/includes/installer/Installer.php
index 2f3beeb..60bd7d4 100644 (file)
--- a/includes/installer/Installer.php
+++ b/includes/installer/Installer.php
@@ -1,11 +1,18 @@
 <?php
 
+/**
+ * This documentation group collects source code files with deployment functionality.
+ *
+ * @defgroup Deployment Deployment
+ */
+
 /**
  * Base installer class.
  *
  * This class provides the base for installation and update functionality
  * for both MediaWiki core and extensions.
  *
+ * @ingroup Deployment
  * @since 1.17
  */
 abstract class Installer {

diff --git a/includes/installer/LocalSettingsGenerator.php b/includes/installer/LocalSettingsGenerator.php
index 84cf2e4..8b2e266 100644 (file)
--- a/includes/installer/LocalSettingsGenerator.php
+++ b/includes/installer/LocalSettingsGenerator.php
@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * Class for manipulating LocalSettings.
+ *
+ * @ingroup Deployment
+ * @since 1.17
+ */
 class LocalSettingsGenerator {
        
        private $extensions = array();

diff --git a/includes/installer/MysqlInstaller.php b/includes/installer/MysqlInstaller.php
index 4e50fe0..d2d6bdf 100644 (file)
--- a/includes/installer/MysqlInstaller.php
+++ b/includes/installer/MysqlInstaller.php
@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * Class for setting up the MediaWiki database using MySQL.
+ * 
+ * @ingroup Deployment
+ * @since 1.17
+ */
 class MysqlInstaller extends DatabaseInstaller {
        
        protected $globalNames = array(
@@ -60,10 +66,10 @@ class MysqlInstaller extends DatabaseInstaller {
        }
 
        public function submitConnectForm() {
-               // Get variables from the request
+               // Get variables from the request.
                $newValues = $this->setVarsFromRequest( array( 'wgDBserver', 'wgDBname', 'wgDBprefix' ) );
 
-               // Validate them
+               // Validate them.
                $status = Status::newGood();
                if ( !strlen( $newValues['wgDBname'] ) ) {
                        $status->fatal( 'config-missing-db-name' );

diff --git a/includes/installer/MysqlUpdater.php b/includes/installer/MysqlUpdater.php
index f6db9f7..03b2dfd 100644 (file)
--- a/includes/installer/MysqlUpdater.php
+++ b/includes/installer/MysqlUpdater.php
@@ -1,9 +1,13 @@
 <?php
 
 /**
- * Mysql update list and mysql-specific update functions
+ * Mysql update list and mysql-specific update functions.
+ * 
+ * @ingroup Deployment
+ * @since 1.17
  */
 class MysqlUpdater extends DatabaseUpdater {
+       
        protected function getCoreUpdateList() {
                return array(
                        '1.2' => array(

diff --git a/includes/installer/OracleInstaller.php b/includes/installer/OracleInstaller.php
index 3d56448..5392368 100644 (file)
--- a/includes/installer/OracleInstaller.php
+++ b/includes/installer/OracleInstaller.php
@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * Class for setting up the MediaWiki database using Oracle.
+ * 
+ * @ingroup Deployment
+ * @since 1.17
+ */
 class OracleInstaller extends DatabaseInstaller {
 
        protected $globalNames = array(

diff --git a/includes/installer/PostgresInstaller.php b/includes/installer/PostgresInstaller.php
index e0345b2..bb812e8 100644 (file)
--- a/includes/installer/PostgresInstaller.php
+++ b/includes/installer/PostgresInstaller.php
@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * Class for setting up the MediaWiki database using Postgres.
+ * 
+ * @ingroup Deployment
+ * @since 1.17
+ */
 class PostgresInstaller extends DatabaseInstaller {
 
        protected $globalNames = array(

diff --git a/includes/installer/SqliteInstaller.php b/includes/installer/SqliteInstaller.php
index fe7f5c2..1c7ad48 100644 (file)
--- a/includes/installer/SqliteInstaller.php
+++ b/includes/installer/SqliteInstaller.php
@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * Class for setting up the MediaWiki database using SQLLite.
+ * 
+ * @ingroup Deployment
+ * @since 1.17
+ */
 class SqliteInstaller extends DatabaseInstaller {
        
        protected $globalNames = array(

diff --git a/includes/installer/SqliteUpdater.php b/includes/installer/SqliteUpdater.php
index 99a8f12..e5bed0a 100644 (file)
--- a/includes/installer/SqliteUpdater.php
+++ b/includes/installer/SqliteUpdater.php
@@ -1,8 +1,13 @@
 <?php
+
 /**
- * Sqlite
+ * Class for handling updates to Sqlite databases.
+ * 
+ * @ingroup Deployment
+ * @since 1.17
  */
 class SqliteUpdater extends DatabaseUpdater {
+       
        protected function getCoreUpdateList() {
                return array(
                        '1.14' => array(

diff --git a/includes/installer/WebInstaller.php b/includes/installer/WebInstaller.php
index f3a9079..408fc52 100644 (file)
--- a/includes/installer/WebInstaller.php
+++ b/includes/installer/WebInstaller.php
@@ -3,6 +3,7 @@
 /**
  * Class for the core installer web interface.
  * 
+ * @ingroup Deployment
  * @since 1.17
  */
 class WebInstaller extends CoreInstaller {

diff --git a/includes/installer/WebInstallerOutput.php b/includes/installer/WebInstallerOutput.php
index 019fd6c..27e7bed 100644 (file)
--- a/includes/installer/WebInstallerOutput.php
+++ b/includes/installer/WebInstallerOutput.php
@@ -7,6 +7,9 @@
  * the interests of separation of concerns: if we used a subclass, there would be 
  * quite a lot of things you could do in OutputPage that would break the installer, 
  * that wouldn't be immediately obvious. 
+ * 
+ * @ingroup Deployment
+ * @since 1.17
  */
 class WebInstallerOutput {
        

diff --git a/includes/installer/WebInstallerPage.php b/includes/installer/WebInstallerPage.php
index a630b5d..be358ff 100644 (file)
--- a/includes/installer/WebInstallerPage.php
+++ b/includes/installer/WebInstallerPage.php
@@ -2,6 +2,9 @@
 
 /**
  * Abstract class to define pages for the web installer.
+ * 
+ * @ingroup Deployment
+ * @since 1.17
  */
 abstract class WebInstallerPage {