Index: trunk/phase3/includes/installer/DatabaseUpdater.php |
— | — | @@ -3,6 +3,9 @@ |
4 | 4 | /* |
5 | 5 | * Class for handling database updates. Roughly based off of updaters.inc, with |
6 | 6 | * a few improvements :) |
| 7 | + * |
| 8 | + * @ingroup Deployment |
| 9 | + * @since 1.17 |
7 | 10 | */ |
8 | 11 | abstract class DatabaseUpdater { |
9 | 12 | |
Index: trunk/phase3/includes/installer/MysqlUpdater.php |
— | — | @@ -1,9 +1,13 @@ |
2 | 2 | <?php |
3 | 3 | |
4 | 4 | /** |
5 | | - * Mysql update list and mysql-specific update functions |
| 5 | + * Mysql update list and mysql-specific update functions. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
6 | 9 | */ |
7 | 10 | class MysqlUpdater extends DatabaseUpdater { |
| 11 | + |
8 | 12 | protected function getCoreUpdateList() { |
9 | 13 | return array( |
10 | 14 | '1.2' => array( |
Index: trunk/phase3/includes/installer/WebInstaller.php |
— | — | @@ -3,6 +3,7 @@ |
4 | 4 | /** |
5 | 5 | * Class for the core installer web interface. |
6 | 6 | * |
| 7 | + * @ingroup Deployment |
7 | 8 | * @since 1.17 |
8 | 9 | */ |
9 | 10 | class WebInstaller extends CoreInstaller { |
Index: trunk/phase3/includes/installer/Installer.php |
— | — | @@ -1,11 +1,18 @@ |
2 | 2 | <?php |
3 | 3 | |
4 | 4 | /** |
| 5 | + * This documentation group collects source code files with deployment functionality. |
| 6 | + * |
| 7 | + * @defgroup Deployment Deployment |
| 8 | + */ |
| 9 | + |
| 10 | +/** |
5 | 11 | * Base installer class. |
6 | 12 | * |
7 | 13 | * This class provides the base for installation and update functionality |
8 | 14 | * for both MediaWiki core and extensions. |
9 | 15 | * |
| 16 | + * @ingroup Deployment |
10 | 17 | * @since 1.17 |
11 | 18 | */ |
12 | 19 | abstract class Installer { |
Index: trunk/phase3/includes/installer/CoreInstaller.php |
— | — | @@ -4,6 +4,7 @@ |
5 | 5 | * Base core installer class. |
6 | 6 | * Handles everything that is independent of user interface. |
7 | 7 | * |
| 8 | + * @ingroup Deployment |
8 | 9 | * @since 1.17 |
9 | 10 | */ |
10 | 11 | abstract class CoreInstaller extends Installer { |
Index: trunk/phase3/includes/installer/WebInstallerOutput.php |
— | — | @@ -7,6 +7,9 @@ |
8 | 8 | * the interests of separation of concerns: if we used a subclass, there would be |
9 | 9 | * quite a lot of things you could do in OutputPage that would break the installer, |
10 | 10 | * that wouldn't be immediately obvious. |
| 11 | + * |
| 12 | + * @ingroup Deployment |
| 13 | + * @since 1.17 |
11 | 14 | */ |
12 | 15 | class WebInstallerOutput { |
13 | 16 | |
Index: trunk/phase3/includes/installer/SqliteInstaller.php |
— | — | @@ -1,5 +1,11 @@ |
2 | 2 | <?php |
3 | 3 | |
| 4 | +/** |
| 5 | + * Class for setting up the MediaWiki database using SQLLite. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
| 9 | + */ |
4 | 10 | class SqliteInstaller extends DatabaseInstaller { |
5 | 11 | |
6 | 12 | protected $globalNames = array( |
Index: trunk/phase3/includes/installer/DatabaseInstaller.php |
— | — | @@ -2,6 +2,9 @@ |
3 | 3 | |
4 | 4 | /** |
5 | 5 | * Base class for DBMS-specific installation helper classes. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
6 | 9 | */ |
7 | 10 | abstract class DatabaseInstaller { |
8 | 11 | |
Index: trunk/phase3/includes/installer/LocalSettingsGenerator.php |
— | — | @@ -1,5 +1,11 @@ |
2 | 2 | <?php |
3 | 3 | |
| 4 | +/** |
| 5 | + * Class for manipulating LocalSettings. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
| 9 | + */ |
4 | 10 | class LocalSettingsGenerator { |
5 | 11 | |
6 | 12 | private $extensions = array(); |
Index: trunk/phase3/includes/installer/MysqlInstaller.php |
— | — | @@ -1,5 +1,11 @@ |
2 | 2 | <?php |
3 | 3 | |
| 4 | +/** |
| 5 | + * Class for setting up the MediaWiki database using MySQL. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
| 9 | + */ |
4 | 10 | class MysqlInstaller extends DatabaseInstaller { |
5 | 11 | |
6 | 12 | protected $globalNames = array( |
— | — | @@ -60,10 +66,10 @@ |
61 | 67 | } |
62 | 68 | |
63 | 69 | public function submitConnectForm() { |
64 | | - // Get variables from the request |
| 70 | + // Get variables from the request. |
65 | 71 | $newValues = $this->setVarsFromRequest( array( 'wgDBserver', 'wgDBname', 'wgDBprefix' ) ); |
66 | 72 | |
67 | | - // Validate them |
| 73 | + // Validate them. |
68 | 74 | $status = Status::newGood(); |
69 | 75 | if ( !strlen( $newValues['wgDBname'] ) ) { |
70 | 76 | $status->fatal( 'config-missing-db-name' ); |
Index: trunk/phase3/includes/installer/OracleInstaller.php |
— | — | @@ -1,5 +1,11 @@ |
2 | 2 | <?php |
3 | 3 | |
| 4 | +/** |
| 5 | + * Class for setting up the MediaWiki database using Oracle. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
| 9 | + */ |
4 | 10 | class OracleInstaller extends DatabaseInstaller { |
5 | 11 | |
6 | 12 | protected $globalNames = array( |
Index: trunk/phase3/includes/installer/PostgresInstaller.php |
— | — | @@ -1,5 +1,11 @@ |
2 | 2 | <?php |
3 | 3 | |
| 4 | +/** |
| 5 | + * Class for setting up the MediaWiki database using Postgres. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
| 9 | + */ |
4 | 10 | class PostgresInstaller extends DatabaseInstaller { |
5 | 11 | |
6 | 12 | protected $globalNames = array( |
Index: trunk/phase3/includes/installer/CliInstaller.php |
— | — | @@ -3,6 +3,7 @@ |
4 | 4 | /** |
5 | 5 | * Class for the core installer command line interface. |
6 | 6 | * |
| 7 | + * @ingroup Deployment |
7 | 8 | * @since 1.17 |
8 | 9 | */ |
9 | 10 | class CliInstaller extends CoreInstaller { |
Index: trunk/phase3/includes/installer/SqliteUpdater.php |
— | — | @@ -1,8 +1,13 @@ |
2 | 2 | <?php |
| 3 | + |
3 | 4 | /** |
4 | | - * Sqlite |
| 5 | + * Class for handling updates to Sqlite databases. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
5 | 9 | */ |
6 | 10 | class SqliteUpdater extends DatabaseUpdater { |
| 11 | + |
7 | 12 | protected function getCoreUpdateList() { |
8 | 13 | return array( |
9 | 14 | '1.14' => array( |
Index: trunk/phase3/includes/installer/WebInstallerPage.php |
— | — | @@ -2,6 +2,9 @@ |
3 | 3 | |
4 | 4 | /** |
5 | 5 | * Abstract class to define pages for the web installer. |
| 6 | + * |
| 7 | + * @ingroup Deployment |
| 8 | + * @since 1.17 |
6 | 9 | */ |
7 | 10 | abstract class WebInstallerPage { |
8 | 11 | |