r63617 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r63616‎ | r63617 | r63618 >
Date:20:59, 11 March 2010
Author:ialex
Status:ok
Tags:
Comment:
Fixed some doxygen warnings
Modified paths:
  • /trunk/phase3/includes/db/LBFactory.php (modified) (history)
  • /trunk/phase3/includes/db/LoadBalancer.php (modified) (history)
  • /trunk/phase3/includes/db/LoadMonitor.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/db/LBFactory.php
@@ -44,7 +44,7 @@
4545 * Create a new load balancer object. The resulting object will be untracked,
4646 * not chronology-protected, and the caller is responsible for cleaning it up.
4747 *
48 - * @param string $wiki Wiki ID, or false for the current wiki
 48+ * @param $wiki String: wiki ID, or false for the current wiki
4949 * @return LoadBalancer
5050 */
5151 abstract function newMainLB( $wiki = false );
@@ -52,7 +52,7 @@
5353 /**
5454 * Get a cached (tracked) load balancer object.
5555 *
56 - * @param string $wiki Wiki ID, or false for the current wiki
 56+ * @param $wiki String: wiki ID, or false for the current wiki
5757 * @return LoadBalancer
5858 */
5959 abstract function getMainLB( $wiki = false );
@@ -62,16 +62,16 @@
6363 * untracked, not chronology-protected, and the caller is responsible for
6464 * cleaning it up.
6565 *
66 - * @param string $cluster External storage cluster, or false for core
67 - * @param string $wiki Wiki ID, or false for the current wiki
 66+ * @param $cluster String: external storage cluster, or false for core
 67+ * @param $wiki String: wiki ID, or false for the current wiki
6868 */
6969 abstract function newExternalLB( $cluster, $wiki = false );
7070
7171 /*
7272 * Get a cached (tracked) load balancer for external storage
7373 *
74 - * @param string $cluster External storage cluster, or false for core
75 - * @param string $wiki Wiki ID, or false for the current wiki
 74+ * @param $cluster String: external storage cluster, or false for core
 75+ * @param $wiki String: wiki ID, or false for the current wiki
7676 */
7777 abstract function &getExternalLB( $cluster, $wiki = false );
7878
@@ -208,7 +208,7 @@
209209 /**
210210 * Initialise a LoadBalancer to give it appropriate chronology protection.
211211 *
212 - * @param LoadBalancer $lb
 212+ * @param $lb LoadBalancer
213213 */
214214 function initLB( $lb ) {
215215 if ( $this->startupPos === null ) {
@@ -233,7 +233,7 @@
234234 * Notify the ChronologyProtector that the LoadBalancer is about to shut
235235 * down. Saves replication positions.
236236 *
237 - * @param LoadBalancer $lb
 237+ * @param $lb LoadBalancer
238238 */
239239 function shutdownLB( $lb ) {
240240 // Don't start a session, don't bother with non-replicated setups
Index: trunk/phase3/includes/db/LoadBalancer.php
@@ -20,9 +20,9 @@
2121 /* private */ var $mLoadMonitorClass, $mLoadMonitor;
2222
2323 /**
24 - * @param array $params Array with keys:
 24+ * @param $params Array with keys:
2525 * servers Required. Array of server info structures.
26 - * failFunction Deprecated, use exceptions instead.
 26+ * failFunction Deprecated, use exceptions instead.
2727 * masterWaitTimeout Replication lag wait timeout
2828 * loadMonitor Name of a class used to fetch server lag and load.
2929 */
@@ -398,9 +398,9 @@
399399 /**
400400 * Get a connection by index
401401 * This is the main entry point for this class.
402 - * @param int $i Database
403 - * @param array $groups Query groups
404 - * @param string $wiki Wiki ID
 402+ * @param $i Integer: server index
 403+ * @param $groups Array: query groups
 404+ * @param $wiki String: wiki ID
405405 */
406406 public function &getConnection( $i, $groups = array(), $wiki = false ) {
407407 global $wgDBtype;
@@ -509,9 +509,9 @@
510510 * On error, returns false, and the connection which caused the
511511 * error will be available via $this->mErrorConnection.
512512 *
513 - * @param integer $i Server index
514 - * @param string $wiki Wiki ID to open
515 - * @return Database
 513+ * @param $i Integer: server index
 514+ * @param $wiki String: wiki ID to open
 515+ * @return DatabaseBase
516516 *
517517 * @access private
518518 */
@@ -554,9 +554,9 @@
555555 * On error, returns false, and the connection which caused the
556556 * error will be available via $this->mErrorConnection.
557557 *
558 - * @param integer $i Server index
559 - * @param string $wiki Wiki ID to open
560 - * @return Database
 558+ * @param $i Integer: server index
 559+ * @param $wiki String: wiki ID to open
 560+ * @return DatabaseBase
561561 */
562562 function openForeignConnection( $i, $wiki ) {
563563 wfProfileIn(__METHOD__);
@@ -615,6 +615,8 @@
616616
617617 /**
618618 * Test if the specified index represents an open connection
 619+ *
 620+ * @param $index Integer: server index
619621 * @access private
620622 */
621623 function isOpen( $index ) {
Index: trunk/phase3/includes/db/LoadMonitor.php
@@ -12,9 +12,9 @@
1313
1414 /**
1515 * Perform pre-connection load ratio adjustment.
16 - * @param array $loads
17 - * @param string $group The selected query group
18 - * @param string $wiki
 16+ * @param $loads Array
 17+ * @param $group String: the selected query group
 18+ * @param $wiki String
1919 */
2020 function scaleLoads( &$loads, $group = false, $wiki = false );
2121
@@ -31,8 +31,8 @@
3232 * to the running thread count. The threshold may be false, which indicates
3333 * that the sysadmin has not configured this feature.
3434 *
35 - * @param Database $conn
36 - * @param float $threshold
 35+ * @param $conn DatabaseBase
 36+ * @param $threshold Float
3737 */
3838 function postConnectionBackoff( $conn, $threshold );
3939

Status & tagging log