diff options
author | umherirrender <umherirrender_de.wp@web.de> | 2014-04-14 21:43:18 +0200 |
---|---|---|
committer | Umherirrender <umherirrender_de.wp@web.de> | 2014-04-14 19:52:18 +0000 |
commit | 9c614ac02d884abc110146d520cc842998d85e6a (patch) | |
tree | b18868a0d9ab7363ca82f13cfb8d3cd75dd0bc00 /includes/externalstore | |
parent | 8f2ebcbf6769451c51e4c6a8dc138d619ba8d6aa (diff) | |
download | mediawikicore-9c614ac02d884abc110146d520cc842998d85e6a.tar.gz mediawikicore-9c614ac02d884abc110146d520cc842998d85e6a.zip |
Fixed some @params documentation
Swapped some "$var type" to "type $var" or added missing types
before the $var. Changed some other types to match the more common
spelling. Makes beginning of some text in captial.
Change-Id: I8c9f30128b46086064326708a4878228ba459447
Diffstat (limited to 'includes/externalstore')
-rw-r--r-- | includes/externalstore/ExternalStore.php | 6 | ||||
-rw-r--r-- | includes/externalstore/ExternalStoreDB.php | 22 | ||||
-rw-r--r-- | includes/externalstore/ExternalStoreMedium.php | 6 |
3 files changed, 17 insertions, 17 deletions
diff --git a/includes/externalstore/ExternalStore.php b/includes/externalstore/ExternalStore.php index 9e9d976de724..9e09b222b010 100644 --- a/includes/externalstore/ExternalStore.php +++ b/includes/externalstore/ExternalStore.php @@ -131,7 +131,7 @@ class ExternalStore { * class itself as a parameter. * * @param string $url A partial external store URL ("<store type>://<location>") - * @param $data string + * @param string $data * @param array $params Associative array of ExternalStoreMedium parameters * @return string|bool The URL of the stored data item, or false on error * @throws MWException @@ -218,8 +218,8 @@ class ExternalStore { } /** - * @param $data string - * @param $wiki string + * @param string $data + * @param string $wiki * @return string|bool The URL of the stored data item, or false on error * @throws MWException */ diff --git a/includes/externalstore/ExternalStoreDB.php b/includes/externalstore/ExternalStoreDB.php index 9de81e060b7c..5774a24c783f 100644 --- a/includes/externalstore/ExternalStoreDB.php +++ b/includes/externalstore/ExternalStoreDB.php @@ -106,8 +106,8 @@ class ExternalStoreDB extends ExternalStoreMedium { /** * Get a LoadBalancer for the specified cluster * - * @param string $cluster cluster name - * @return LoadBalancer object + * @param string $cluster Cluster name + * @return LoadBalancer */ function getLoadBalancer( $cluster ) { $wiki = isset( $this->params['wiki'] ) ? $this->params['wiki'] : false; @@ -118,8 +118,8 @@ class ExternalStoreDB extends ExternalStoreMedium { /** * Get a slave database connection for the specified cluster * - * @param string $cluster cluster name - * @return DatabaseBase object + * @param string $cluster Cluster name + * @return DatabaseBase */ function getSlave( $cluster ) { global $wgDefaultExternalStore; @@ -140,8 +140,8 @@ class ExternalStoreDB extends ExternalStoreMedium { /** * Get a master database connection for the specified cluster * - * @param string $cluster cluster name - * @return DatabaseBase object + * @param string $cluster Cluster name + * @return DatabaseBase */ function getMaster( $cluster ) { $wiki = isset( $this->params['wiki'] ) ? $this->params['wiki'] : false; @@ -153,8 +153,8 @@ class ExternalStoreDB extends ExternalStoreMedium { /** * Get the 'blobs' table name for this database * - * @param $db DatabaseBase - * @return String: table name ('blobs' by default) + * @param DatabaseBase $db + * @return string Table name ('blobs' by default) */ function getTable( $db ) { $table = $db->getLBInfo( 'blobs table' ); @@ -169,9 +169,9 @@ class ExternalStoreDB extends ExternalStoreMedium { * Fetch a blob item out of the database; a cache of the last-loaded * blob will be kept so that multiple loads out of a multi-item blob * can avoid redundant database access and decompression. - * @param $cluster - * @param $id - * @param $itemID + * @param string $cluster + * @param string $id + * @param string $itemID * @return mixed * @private */ diff --git a/includes/externalstore/ExternalStoreMedium.php b/includes/externalstore/ExternalStoreMedium.php index a526df609c95..e9c34a4d478d 100644 --- a/includes/externalstore/ExternalStoreMedium.php +++ b/includes/externalstore/ExternalStoreMedium.php @@ -29,7 +29,7 @@ * @since 1.21 */ abstract class ExternalStoreMedium { - /** @var Array */ + /** @var array */ protected $params = array(); /** @@ -71,8 +71,8 @@ abstract class ExternalStoreMedium { /** * Insert a data item into a given location * - * @param string $location the location name - * @param string $data the data item + * @param string $location The location name + * @param string $data The data item * @return string|bool The URL of the stored data item, or false on error * @throws MWException */ |