From 635e2c38f2ce1887c6e1269706af52c5d66a1089 Mon Sep 17 00:00:00 2001
From: Jeroen De Dauw <jeroendedauw@users.mediawiki.org>
Date: Thu, 29 Jul 2010 18:36:39 +0000
Subject: [PATCH] Added deployment documentation group

---
 includes/installer/CliInstaller.php           |  1 +
 includes/installer/CoreInstaller.php          |  1 +
 includes/installer/DatabaseInstaller.php      |  3 +++
 includes/installer/DatabaseUpdater.php        |  3 +++
 includes/installer/Installer.php              |  7 +++++++
 includes/installer/LocalSettingsGenerator.php |  6 ++++++
 includes/installer/MysqlInstaller.php         | 10 ++++++++--
 includes/installer/MysqlUpdater.php           |  6 +++++-
 includes/installer/OracleInstaller.php        |  6 ++++++
 includes/installer/PostgresInstaller.php      |  6 ++++++
 includes/installer/SqliteInstaller.php        |  6 ++++++
 includes/installer/SqliteUpdater.php          |  7 ++++++-
 includes/installer/WebInstaller.php           |  1 +
 includes/installer/WebInstallerOutput.php     |  3 +++
 includes/installer/WebInstallerPage.php       |  3 +++
 15 files changed, 65 insertions(+), 4 deletions(-)

diff --git a/includes/installer/CliInstaller.php b/includes/installer/CliInstaller.php
index a78597720e..56602b5efa 100644
--- 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 09b6d1b8fd..5297d19ccd 100644
--- 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 acf0e6891c..456e8e5e35 100644
--- 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 c817f8051b..d090f8502d 100644
--- 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 2f3beebc15..60bd7d470f 100644
--- 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 84cf2e4a9f..8b2e266c91 100644
--- 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 4e50fe084e..d2d6bdf685 100644
--- 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 f6db9f77e0..03b2dfdb2d 100644
--- 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 3d56448f32..53923686d5 100644
--- 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 e0345b28e7..bb812e84ba 100644
--- 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 fe7f5c2b5b..1c7ad48d16 100644
--- 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 99a8f1245b..e5bed0a15b 100644
--- 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 f3a90799ce..408fc528bf 100644
--- 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 019fd6cfc4..27e7bede0e 100644
--- 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 a630b5d181..be358ff6bd 100644
--- 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 {
 	
-- 
2.20.1