Index: trunk/phase3/includes/db/LBFactory.php |
— | — | @@ -44,7 +44,7 @@ |
45 | 45 | * Create a new load balancer object. The resulting object will be untracked, |
46 | 46 | * not chronology-protected, and the caller is responsible for cleaning it up. |
47 | 47 | * |
48 | | - * @param string $wiki Wiki ID, or false for the current wiki |
| 48 | + * @param $wiki String: wiki ID, or false for the current wiki |
49 | 49 | * @return LoadBalancer |
50 | 50 | */ |
51 | 51 | abstract function newMainLB( $wiki = false ); |
— | — | @@ -52,7 +52,7 @@ |
53 | 53 | /** |
54 | 54 | * Get a cached (tracked) load balancer object. |
55 | 55 | * |
56 | | - * @param string $wiki Wiki ID, or false for the current wiki |
| 56 | + * @param $wiki String: wiki ID, or false for the current wiki |
57 | 57 | * @return LoadBalancer |
58 | 58 | */ |
59 | 59 | abstract function getMainLB( $wiki = false ); |
— | — | @@ -62,16 +62,16 @@ |
63 | 63 | * untracked, not chronology-protected, and the caller is responsible for |
64 | 64 | * cleaning it up. |
65 | 65 | * |
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 |
68 | 68 | */ |
69 | 69 | abstract function newExternalLB( $cluster, $wiki = false ); |
70 | 70 | |
71 | 71 | /* |
72 | 72 | * Get a cached (tracked) load balancer for external storage |
73 | 73 | * |
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 |
76 | 76 | */ |
77 | 77 | abstract function &getExternalLB( $cluster, $wiki = false ); |
78 | 78 | |
— | — | @@ -208,7 +208,7 @@ |
209 | 209 | /** |
210 | 210 | * Initialise a LoadBalancer to give it appropriate chronology protection. |
211 | 211 | * |
212 | | - * @param LoadBalancer $lb |
| 212 | + * @param $lb LoadBalancer |
213 | 213 | */ |
214 | 214 | function initLB( $lb ) { |
215 | 215 | if ( $this->startupPos === null ) { |
— | — | @@ -233,7 +233,7 @@ |
234 | 234 | * Notify the ChronologyProtector that the LoadBalancer is about to shut |
235 | 235 | * down. Saves replication positions. |
236 | 236 | * |
237 | | - * @param LoadBalancer $lb |
| 237 | + * @param $lb LoadBalancer |
238 | 238 | */ |
239 | 239 | function shutdownLB( $lb ) { |
240 | 240 | // Don't start a session, don't bother with non-replicated setups |
Index: trunk/phase3/includes/db/LoadBalancer.php |
— | — | @@ -20,9 +20,9 @@ |
21 | 21 | /* private */ var $mLoadMonitorClass, $mLoadMonitor; |
22 | 22 | |
23 | 23 | /** |
24 | | - * @param array $params Array with keys: |
| 24 | + * @param $params Array with keys: |
25 | 25 | * servers Required. Array of server info structures. |
26 | | - * failFunction Deprecated, use exceptions instead. |
| 26 | + * failFunction Deprecated, use exceptions instead. |
27 | 27 | * masterWaitTimeout Replication lag wait timeout |
28 | 28 | * loadMonitor Name of a class used to fetch server lag and load. |
29 | 29 | */ |
— | — | @@ -398,9 +398,9 @@ |
399 | 399 | /** |
400 | 400 | * Get a connection by index |
401 | 401 | * 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 |
405 | 405 | */ |
406 | 406 | public function &getConnection( $i, $groups = array(), $wiki = false ) { |
407 | 407 | global $wgDBtype; |
— | — | @@ -509,9 +509,9 @@ |
510 | 510 | * On error, returns false, and the connection which caused the |
511 | 511 | * error will be available via $this->mErrorConnection. |
512 | 512 | * |
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 |
516 | 516 | * |
517 | 517 | * @access private |
518 | 518 | */ |
— | — | @@ -554,9 +554,9 @@ |
555 | 555 | * On error, returns false, and the connection which caused the |
556 | 556 | * error will be available via $this->mErrorConnection. |
557 | 557 | * |
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 |
561 | 561 | */ |
562 | 562 | function openForeignConnection( $i, $wiki ) { |
563 | 563 | wfProfileIn(__METHOD__); |
— | — | @@ -615,6 +615,8 @@ |
616 | 616 | |
617 | 617 | /** |
618 | 618 | * Test if the specified index represents an open connection |
| 619 | + * |
| 620 | + * @param $index Integer: server index |
619 | 621 | * @access private |
620 | 622 | */ |
621 | 623 | function isOpen( $index ) { |
Index: trunk/phase3/includes/db/LoadMonitor.php |
— | — | @@ -12,9 +12,9 @@ |
13 | 13 | |
14 | 14 | /** |
15 | 15 | * 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 |
19 | 19 | */ |
20 | 20 | function scaleLoads( &$loads, $group = false, $wiki = false ); |
21 | 21 | |
— | — | @@ -31,8 +31,8 @@ |
32 | 32 | * to the running thread count. The threshold may be false, which indicates |
33 | 33 | * that the sysadmin has not configured this feature. |
34 | 34 | * |
35 | | - * @param Database $conn |
36 | | - * @param float $threshold |
| 35 | + * @param $conn DatabaseBase |
| 36 | + * @param $threshold Float |
37 | 37 | */ |
38 | 38 | function postConnectionBackoff( $conn, $threshold ); |
39 | 39 | |