Added some docs
authorJeroen De Dauw <jeroendedauw@users.mediawiki.org>
Tue, 10 Aug 2010 06:17:49 +0000 (06:17 +0000)
committerJeroen De Dauw <jeroendedauw@users.mediawiki.org>
Tue, 10 Aug 2010 06:17:49 +0000 (06:17 +0000)
includes/GlobalFunctions.php
includes/db/LoadBalancer.php

index 81705d3..c69cdad 100644 (file)
@@ -2954,6 +2954,8 @@ function wfSplitWikiID( $wiki ) {
  * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
  * will always return the same object, unless the underlying connection or load
  * balancer is manually destroyed.
+ * 
+ * @return DatabaseBase
  */
 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
        return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
index 30f76b7..3b41397 100644 (file)
@@ -400,9 +400,12 @@ class LoadBalancer {
        /**
         * Get a connection by index
         * This is the main entry point for this class.
+        * 
         * @param $i Integer: server index
         * @param $groups Array: query groups
         * @param $wiki String: wiki ID
+        * 
+        * @return DatabaseBase
         */
        public function &getConnection( $i, $groups = array(), $wiki = false ) {
                wfProfileIn( __METHOD__ );