Update docs for return and exception info

[lhc/web/wiklou.git] / includes / db / LBFactory_Multi.php

diff --git a/includes/db/LBFactory_Multi.php b/includes/db/LBFactory_Multi.php
index 5f7cf0d..9b468a7 100644 (file)
--- a/includes/db/LBFactory_Multi.php
+++ b/includes/db/LBFactory_Multi.php
@@ -1,6 +1,21 @@
 <?php
 /**
- * Advanced generator of database load balancing objects for wiki farms
+ * Advanced generator of database load balancing objects for wiki farms.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
  * @ingroup Database
@@ -54,7 +69,8 @@ class LBFactory_Multi extends LBFactory {
        var $lastWiki, $lastSection;
 
        /**
-        * @param $conf
+        * @param $conf array
+        * @throws MWException
         */
        function __construct( $conf ) {
                $this->chronProt = new ChronologyProtector;
@@ -138,8 +154,9 @@ class LBFactory_Multi extends LBFactory {
        }
 
        /**
-        * @param $cluster
-        * @param $wiki
+        * @param String $cluster
+        * @param bool $wiki
+        * @throws MWException
         * @return LoadBalancer
         */
        function newExternalLB( $cluster, $wiki = false ) {
@@ -173,7 +190,7 @@ class LBFactory_Multi extends LBFactory {
         * Make a new load balancer object based on template and load array
         *
         * @param $template
-        * @param $loads
+        * @param $loads array
         * @param $groupLoads
         * @return LoadBalancer
         */
@@ -191,7 +208,7 @@ class LBFactory_Multi extends LBFactory {
         * Make a server array as expected by LoadBalancer::__construct, using a template and load array
         *
         * @param $template
-        * @param $loads
+        * @param $loads array
         * @param $groupLoads
         * @return array
         */
@@ -248,7 +265,7 @@ class LBFactory_Multi extends LBFactory {
 
        /**
         * Get the database name and prefix based on the wiki ID
-        * @param bool $wiki
+        * @param $wiki bool
         * @return array
         */
        function getDBNameAndPrefix( $wiki = false ) {