From: Sam Reed <reedy@users.mediawiki.org>
Date: Sat, 19 Feb 2011 00:44:38 +0000 (+0000)
Subject: More function level documentation
X-Git-Tag: 1.31.0-rc.0~31909
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/comptes/ajouter.php?a=commitdiff_plain;h=7ebf2e5165d3eab9fc9725c51119475659b0b834;p=lhc%2Fweb%2Fwiklou.git

More function level documentation

Fixup some indenting
---

diff --git a/includes/Status.php b/includes/Status.php
index efd357b583..f285cf75ff 100644
--- a/includes/Status.php
+++ b/includes/Status.php
@@ -237,7 +237,7 @@ class Status {
 	/**
 	 * Merge another status object into this one
 	 *
-	 * @param $other Other Status object
+	 * @param $other Status Other Status object
 	 * @param $overwriteValue Boolean: whether to override the "value" member
 	 */
 	function merge( $other, $overwriteValue = false ) {
diff --git a/includes/db/Database.php b/includes/db/Database.php
index 11b9db771e..708b0e2b14 100644
--- a/includes/db/Database.php
+++ b/includes/db/Database.php
@@ -145,6 +145,8 @@ interface DatabaseType {
 	 *
 	 * @param $table string: table name
 	 * @param $field string: field name
+	 *
+	 * @return Field
 	 */
 	function fieldInfo( $table, $field );
 
diff --git a/includes/db/DatabasePostgres.php b/includes/db/DatabasePostgres.php
index 233e39dd91..01f41ee85e 100644
--- a/includes/db/DatabasePostgres.php
+++ b/includes/db/DatabasePostgres.php
@@ -9,8 +9,15 @@
 class PostgresField implements Field {
 	private $name, $tablename, $type, $nullable, $max_length, $deferred, $deferrable, $conname;
 
-	static function fromText($db, $table, $field) {
-	global $wgDBmwschema;
+	/**
+	 * @static
+	 * @param $db DatabaseBase
+	 * @param  $table
+	 * @param  $field
+	 * @return null|PostgresField
+	 */
+	static function fromText( $db, $table, $field ) {
+		global $wgDBmwschema;
 
 		$q = <<<SQL
 SELECT
diff --git a/includes/db/LBFactory_Single.php b/includes/db/LBFactory_Single.php
index 25acdc5b91..e8b5fe8267 100644
--- a/includes/db/LBFactory_Single.php
+++ b/includes/db/LBFactory_Single.php
@@ -39,6 +39,10 @@ class LBFactory_Single extends LBFactory {
  * Helper class for LBFactory_Single.
  */
 class LoadBalancer_Single extends LoadBalancer {
+
+	/**
+	 * @var DatabaseBase
+	 */
 	var $db;
 
 	function __construct( $params ) {
diff --git a/includes/db/LoadMonitor.php b/includes/db/LoadMonitor.php
index 9b959728c3..8b73dd54d2 100644
--- a/includes/db/LoadMonitor.php
+++ b/includes/db/LoadMonitor.php
@@ -117,6 +117,11 @@ class LoadMonitor_MySQL implements LoadMonitor {
 		return $lagTimes;
 	}
 
+	/**
+	 * @param $conn DatabaseBase
+	 * @param $threshold
+	 * @return int
+	 */
 	function postConnectionBackoff( $conn, $threshold ) {
 		if ( !$threshold ) {
 			return 0;
diff --git a/includes/installer/DatabaseInstaller.php b/includes/installer/DatabaseInstaller.php
index cb0f6df32d..be84bd7bfc 100644
--- a/includes/installer/DatabaseInstaller.php
+++ b/includes/installer/DatabaseInstaller.php
@@ -19,7 +19,7 @@ abstract class DatabaseInstaller {
 	 *
 	 * TODO: naming this parent is confusing, 'installer' would be clearer.
 	 *
-	 * @var Installer
+	 * @var WebInstaller
 	 */
 	public $parent;
 
diff --git a/includes/installer/Installer.php b/includes/installer/Installer.php
index 1f6cb8a1c7..3677e786bf 100644
--- a/includes/installer/Installer.php
+++ b/includes/installer/Installer.php
@@ -1274,8 +1274,8 @@ abstract class Installer {
 	/**
 	 * Actually perform the installation.
 	 *
-	 * @param $startCB A callback array for the beginning of each step
-	 * @param $endCB A callback array for the end of each step
+	 * @param $startCB Array A callback array for the beginning of each step
+	 * @param $endCB Array A callback array for the end of each step
 	 *
 	 * @return Array of Status objects
 	 */
diff --git a/includes/installer/MysqlUpdater.php b/includes/installer/MysqlUpdater.php
index 188c58cae9..03d91976a1 100644
--- a/includes/installer/MysqlUpdater.php
+++ b/includes/installer/MysqlUpdater.php
@@ -364,7 +364,6 @@ class MysqlUpdater extends DatabaseUpdater {
 			$this->output( "......<b>Deleted</b> " . $this->db->affectedRows() . " records.\n" );
 		}
 
-
 		$this->output( wfTimestamp( TS_DB ) );
 		$this->output( "......Creating tables.\n" );
 		$this->db->query( "CREATE TABLE $page (
diff --git a/languages/Language.php b/languages/Language.php
index 76d8fd9fc1..b8515f3669 100644
--- a/languages/Language.php
+++ b/languages/Language.php
@@ -199,6 +199,8 @@ class Language {
 
 	/**
 	 * Get the LocalisationCache instance
+	 *
+	 * @return LocalisationCache
 	 */
 	public static function getLocalisationCache() {
 		if ( is_null( self::$dataCache ) ) {