From ba015d3d7692abb9385c6a7daa39aa0e27e0db74 Mon Sep 17 00:00:00 2001
From: Jeroen De Dauw <jeroendedauw@users.mediawiki.org>
Date: Thu, 29 Jul 2010 18:25:10 +0000
Subject: [PATCH] Style and doc improvements

---
 includes/installer/CoreInstaller.php          |  2 +-
 includes/installer/LocalSettingsGenerator.php | 17 ++++++++++++++++-
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/includes/installer/CoreInstaller.php b/includes/installer/CoreInstaller.php
index 7735e02ea3..09b6d1b8fd 100644
--- a/includes/installer/CoreInstaller.php
+++ b/includes/installer/CoreInstaller.php
@@ -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' => '',
diff --git a/includes/installer/LocalSettingsGenerator.php b/includes/installer/LocalSettingsGenerator.php
index f5b268feae..84cf2e4a9f 100644
--- a/includes/installer/LocalSettingsGenerator.php
+++ b/includes/installer/LocalSettingsGenerator.php
@@ -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';
-- 
2.20.1