http://www.mediawiki.org/wiki/Special:Code/MediaWiki/83593
Revision: 83593
Author: reedy
Date: 2011-03-09 17:09:10 +0000 (Wed, 09 Mar 2011)
Log Message:
-----------
More function/member variable documentation
Modified Paths:
--------------
trunk/phase3/includes/db/LBFactory.php
trunk/phase3/includes/db/LoadBalancer.php
trunk/phase3/includes/db/LoadMonitor.php
Modified: trunk/phase3/includes/db/LBFactory.php
===================================================================
--- trunk/phase3/includes/db/LBFactory.php 2011-03-09 16:43:46 UTC (rev
83592)
+++ trunk/phase3/includes/db/LBFactory.php 2011-03-09 17:09:10 UTC (rev
83593)
@@ -11,6 +11,10 @@
* @ingroup Database
*/
abstract class LBFactory {
+
+ /**
+ * @var LBFactory
+ */
static $instance;
/**
@@ -133,6 +137,10 @@
* A simple single-master LBFactory that gets its configuration from the b/c
globals
*/
class LBFactory_Simple extends LBFactory {
+
+ /**
+ * @var LoadBalancer
+ */
var $mainLB;
var $extLBs = array();
Modified: trunk/phase3/includes/db/LoadBalancer.php
===================================================================
--- trunk/phase3/includes/db/LoadBalancer.php 2011-03-09 16:43:46 UTC (rev
83592)
+++ trunk/phase3/includes/db/LoadBalancer.php 2011-03-09 17:09:10 UTC (rev
83593)
@@ -69,6 +69,8 @@
/**
* Get a LoadMonitor instance
+ *
+ * @return LoadMonitor
*/
function getLoadMonitor() {
if ( !isset( $this->mLoadMonitor ) ) {
@@ -354,6 +356,8 @@
/**
* Get any open connection to a given server index, local or foreign
* Returns false if there is no connection open
+ *
+ * @return DatabaseBase
*/
function getAnyOpenConnection( $i ) {
foreach ( $this->mConns as $conns ) {
@@ -467,6 +471,8 @@
* Mark a foreign connection as being available for reuse under a
different
* DB name or prefix. This mechanism is reference-counted, and must be
called
* the same number of times as getConnection() to work.
+ *
+ * @param DatabaseBase $conn
*/
public function reuseConnection( $conn ) {
$serverIndex = $conn->getLBInfo('serverIndex');
Modified: trunk/phase3/includes/db/LoadMonitor.php
===================================================================
--- trunk/phase3/includes/db/LoadMonitor.php 2011-03-09 16:43:46 UTC (rev
83592)
+++ trunk/phase3/includes/db/LoadMonitor.php 2011-03-09 17:09:10 UTC (rev
83593)
@@ -14,6 +14,8 @@
interface LoadMonitor {
/**
* Construct a new LoadMonitor with a given LoadBalancer parent
+ *
+ * @param LoadBalancer $parent
*/
function __construct( $parent );
@@ -57,8 +59,15 @@
* @ingroup Database
*/
class LoadMonitor_MySQL implements LoadMonitor {
- var $parent; // LoadBalancer
+ /**
+ * @var LoadBalancer
+ */
+ var $parent;
+
+ /**
+ * @param LoadBalancer $parent
+ */
function __construct( $parent ) {
$this->parent = $parent;
}
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
