From 01891953bc04749b3567344cc0ba8d4a3785eca6 Mon Sep 17 00:00:00 2001
From: Sam Reed <reedy@users.mediawiki.org>
Date: Wed, 9 Mar 2011 17:09:10 +0000
Subject: [PATCH] More function/member variable documentation

---
 includes/db/LBFactory.php    |  8 ++++++++
 includes/db/LoadBalancer.php |  6 ++++++
 includes/db/LoadMonitor.php  | 11 ++++++++++-
 3 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/includes/db/LBFactory.php b/includes/db/LBFactory.php
index 38d0d6fb32..af2acaa4dc 100644
--- a/includes/db/LBFactory.php
+++ b/includes/db/LBFactory.php
@@ -11,6 +11,10 @@
  * @ingroup Database
  */
 abstract class LBFactory {
+
+	/**
+	 * @var LBFactory
+	 */
 	static $instance;
 
 	/**
@@ -133,6 +137,10 @@ abstract class LBFactory {
  * 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();
 
diff --git a/includes/db/LoadBalancer.php b/includes/db/LoadBalancer.php
index efd37490d6..46c6155546 100644
--- a/includes/db/LoadBalancer.php
+++ b/includes/db/LoadBalancer.php
@@ -69,6 +69,8 @@ class LoadBalancer {
 
 	/**
 	 * Get a LoadMonitor instance
+	 *
+	 * @return LoadMonitor
 	 */
 	function getLoadMonitor() {
 		if ( !isset( $this->mLoadMonitor ) ) {
@@ -354,6 +356,8 @@ class LoadBalancer {
 	/**
 	 * 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 @@ class LoadBalancer {
 	 * 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');
diff --git a/includes/db/LoadMonitor.php b/includes/db/LoadMonitor.php
index 8b73dd54d2..2a23295997 100644
--- a/includes/db/LoadMonitor.php
+++ b/includes/db/LoadMonitor.php
@@ -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 @@ interface LoadMonitor {
  * @ingroup Database
  */
 class LoadMonitor_MySQL implements LoadMonitor {
-	var $parent; // LoadBalancer
 
+	/**
+	 * @var LoadBalancer
+	 */
+	var $parent;
+
+	/**
+	 * @param LoadBalancer $parent
+	 */
 	function __construct( $parent ) {
 		$this->parent = $parent;
 	}
-- 
2.20.1