From 54fd0a4c1f1d0ebaf6b6780fd251263ef526e901 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Thu, 11 Mar 2010 20:59:25 +0000 Subject: [PATCH] Fixed some doxygen warnings --- includes/db/LBFactory.php | 16 ++++++++-------- includes/db/LoadBalancer.php | 24 +++++++++++++----------- includes/db/LoadMonitor.php | 10 +++++----- 3 files changed, 26 insertions(+), 24 deletions(-) diff --git a/includes/db/LBFactory.php b/includes/db/LBFactory.php index 10c871338a..40aca3063b 100644 --- a/includes/db/LBFactory.php +++ b/includes/db/LBFactory.php @@ -44,7 +44,7 @@ abstract class LBFactory { * Create a new load balancer object. The resulting object will be untracked, * not chronology-protected, and the caller is responsible for cleaning it up. * - * @param string $wiki Wiki ID, or false for the current wiki + * @param $wiki String: wiki ID, or false for the current wiki * @return LoadBalancer */ abstract function newMainLB( $wiki = false ); @@ -52,7 +52,7 @@ abstract class LBFactory { /** * Get a cached (tracked) load balancer object. * - * @param string $wiki Wiki ID, or false for the current wiki + * @param $wiki String: wiki ID, or false for the current wiki * @return LoadBalancer */ abstract function getMainLB( $wiki = false ); @@ -62,16 +62,16 @@ abstract class LBFactory { * untracked, not chronology-protected, and the caller is responsible for * cleaning it up. * - * @param string $cluster External storage cluster, or false for core - * @param string $wiki Wiki ID, or false for the current wiki + * @param $cluster String: external storage cluster, or false for core + * @param $wiki String: wiki ID, or false for the current wiki */ abstract function newExternalLB( $cluster, $wiki = false ); /* * Get a cached (tracked) load balancer for external storage * - * @param string $cluster External storage cluster, or false for core - * @param string $wiki Wiki ID, or false for the current wiki + * @param $cluster String: external storage cluster, or false for core + * @param $wiki String: wiki ID, or false for the current wiki */ abstract function &getExternalLB( $cluster, $wiki = false ); @@ -208,7 +208,7 @@ class ChronologyProtector { /** * Initialise a LoadBalancer to give it appropriate chronology protection. * - * @param LoadBalancer $lb + * @param $lb LoadBalancer */ function initLB( $lb ) { if ( $this->startupPos === null ) { @@ -233,7 +233,7 @@ class ChronologyProtector { * Notify the ChronologyProtector that the LoadBalancer is about to shut * down. Saves replication positions. * - * @param LoadBalancer $lb + * @param $lb LoadBalancer */ function shutdownLB( $lb ) { // Don't start a session, don't bother with non-replicated setups diff --git a/includes/db/LoadBalancer.php b/includes/db/LoadBalancer.php index cbf824bf30..04bcc2a1f1 100644 --- a/includes/db/LoadBalancer.php +++ b/includes/db/LoadBalancer.php @@ -20,9 +20,9 @@ class LoadBalancer { /* private */ var $mLoadMonitorClass, $mLoadMonitor; /** - * @param array $params Array with keys: + * @param $params Array with keys: * servers Required. Array of server info structures. - * failFunction Deprecated, use exceptions instead. + * failFunction Deprecated, use exceptions instead. * masterWaitTimeout Replication lag wait timeout * loadMonitor Name of a class used to fetch server lag and load. */ @@ -398,9 +398,9 @@ class LoadBalancer { /** * Get a connection by index * This is the main entry point for this class. - * @param int $i Database - * @param array $groups Query groups - * @param string $wiki Wiki ID + * @param $i Integer: server index + * @param $groups Array: query groups + * @param $wiki String: wiki ID */ public function &getConnection( $i, $groups = array(), $wiki = false ) { global $wgDBtype; @@ -509,9 +509,9 @@ class LoadBalancer { * On error, returns false, and the connection which caused the * error will be available via $this->mErrorConnection. * - * @param integer $i Server index - * @param string $wiki Wiki ID to open - * @return Database + * @param $i Integer: server index + * @param $wiki String: wiki ID to open + * @return DatabaseBase * * @access private */ @@ -554,9 +554,9 @@ class LoadBalancer { * On error, returns false, and the connection which caused the * error will be available via $this->mErrorConnection. * - * @param integer $i Server index - * @param string $wiki Wiki ID to open - * @return Database + * @param $i Integer: server index + * @param $wiki String: wiki ID to open + * @return DatabaseBase */ function openForeignConnection( $i, $wiki ) { wfProfileIn(__METHOD__); @@ -615,6 +615,8 @@ class LoadBalancer { /** * Test if the specified index represents an open connection + * + * @param $index Integer: server index * @access private */ function isOpen( $index ) { diff --git a/includes/db/LoadMonitor.php b/includes/db/LoadMonitor.php index 929ab2b9e1..13a98e5ded 100644 --- a/includes/db/LoadMonitor.php +++ b/includes/db/LoadMonitor.php @@ -12,9 +12,9 @@ interface LoadMonitor { /** * Perform pre-connection load ratio adjustment. - * @param array $loads - * @param string $group The selected query group - * @param string $wiki + * @param $loads Array + * @param $group String: the selected query group + * @param $wiki String */ function scaleLoads( &$loads, $group = false, $wiki = false ); @@ -31,8 +31,8 @@ interface LoadMonitor { * to the running thread count. The threshold may be false, which indicates * that the sysadmin has not configured this feature. * - * @param Database $conn - * @param float $threshold + * @param $conn DatabaseBase + * @param $threshold Float */ function postConnectionBackoff( $conn, $threshold ); -- 2.20.1