More function level documentation

Fixup some indenting

diff --git a/includes/Status.php b/includes/Status.php
index efd357b..f285cf7 100644 (file)
--- 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 11b9db7..708b0e2 100644 (file)
--- 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 233e39d..01f41ee 100644 (file)
--- 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 25acdc5..e8b5fe8 100644 (file)
--- 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 9b95972..8b73dd5 100644 (file)
--- 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 cb0f6df..be84bd7 100644 (file)
--- 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 1f6cb8a..3677e78 100644 (file)
--- 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 188c58c..03d9197 100644 (file)
--- 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 76d8fd9..b8515f3 100644 (file)
--- 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 ) ) {