Style and doc improvements
authorJeroen De Dauw <jeroendedauw@users.mediawiki.org>
Thu, 29 Jul 2010 18:25:10 +0000 (18:25 +0000)
committerJeroen De Dauw <jeroendedauw@users.mediawiki.org>
Thu, 29 Jul 2010 18:25:10 +0000 (18:25 +0000)
includes/installer/CoreInstaller.php
includes/installer/LocalSettingsGenerator.php

index 7735e02..09b6d1b 100644 (file)
@@ -160,7 +160,7 @@ abstract class CoreInstaller extends Installer {
                        'icon' => '{$wgStylePath}/common/images/gnu-fdl.png',
                ),
                'cc-choose' => array(
-                       // details will be filled in by the selector
+                       // Details will be filled in by the selector.
                        'url' => '',
                        'icon' => '',
                        'text' => '',
index f5b268f..84cf2e4 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 
 class LocalSettingsGenerator {
+       
        private $extensions = array();
        private $values = array();
        private $configPath = '';
@@ -64,6 +65,13 @@ class LocalSettingsGenerator {
                $this->values['wgEmergencyContact'] = $this->values['wgPasswordSender'];
        }
 
+       /**
+        * Returns the escaped version of a string of php code.
+        * 
+        * @param $string String
+        * 
+        * @return String
+        */
        public static function escapePhpString( $string ) {
                if ( is_array( $string ) || is_object( $string ) ) {
                        return false;
@@ -85,7 +93,8 @@ class LocalSettingsGenerator {
        /**
         * Return the full text of the generated LocalSettings.php file,
         * including the extensions
-        * @returns String
+        * 
+        * @return String
         */
        public function getText() {
                $localSettings = $this->getDefaultText();
@@ -101,6 +110,9 @@ class LocalSettingsGenerator {
                return $localSettings;
        }
 
+       /**
+        * @return String
+        */
        private function buildMemcachedServerList() {
                $servers = $this->values['_MemCachedServers'];
                
@@ -119,6 +131,9 @@ class LocalSettingsGenerator {
                }
        }
 
+       /**
+        * @return String
+        */     
        private function getDefaultText() {
                if( !$this->values['wgImageMagickConvertCommand'] ) {
                        $this->values['wgImageMagickConvertCommand'] = '/usr/bin/convert';