Umherirrender has uploaded a new change for review. https://gerrit.wikimedia.org/r/149062
Change subject: Cleanup some docs (includes/[a-d]) ...................................................................... Cleanup some docs (includes/[a-d]) - Swap "$variable type" to "type $variable" - Added missing types - Fixed spacing inside docs - Makes beginning of @param/@return/@var/@throws in capital - Changed some types to match the more common spelling Change-Id: I7b65fe04db431342cc58b469dc48f41a50c4e891 --- M includes/actions/CreditsAction.php M includes/actions/HistoryAction.php M includes/api/ApiDelete.php M includes/api/ApiFormatBase.php M includes/api/ApiImageRotate.php M includes/api/ApiMain.php M includes/api/ApiQuery.php M includes/api/ApiQueryImageInfo.php M includes/api/ApiQueryRecentChanges.php M includes/cache/CacheDependency.php M includes/cache/LocalisationCache.php M includes/cache/MessageCache.php M includes/changes/RecentChange.php M includes/clientpool/RedisConnectionPool.php M includes/config/ConfigFactory.php M includes/config/GlobalVarConfig.php M includes/content/CssContentHandler.php M includes/content/JavaScriptContentHandler.php M includes/content/MessageContent.php M includes/content/WikitextContent.php M includes/context/DerivativeContext.php M includes/db/Database.php M includes/db/DatabaseMssql.php M includes/db/DatabaseMysqlBase.php M includes/db/DatabaseOracle.php M includes/db/DatabasePostgres.php M includes/db/DatabaseSqlite.php M includes/db/DatabaseUtility.php M includes/db/IORMTable.php M includes/db/LBFactory.php M includes/db/LBFactoryMulti.php M includes/db/LoadBalancer.php M includes/db/ORMTable.php M includes/deferred/DataUpdate.php M includes/deferred/DeferredUpdates.php M includes/deferred/LinksUpdate.php M includes/deferred/SqlDataUpdate.php M includes/diff/DifferenceEngine.php 38 files changed, 81 insertions(+), 82 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core refs/changes/62/149062/1 diff --git a/includes/actions/CreditsAction.php b/includes/actions/CreditsAction.php index 2bb1be4..dd5195d 100644 --- a/includes/actions/CreditsAction.php +++ b/includes/actions/CreditsAction.php @@ -60,7 +60,7 @@ * * @param int $cnt Maximum list of contributors to show * @param bool $showIfMax Whether to contributors if there more than $cnt - * @return string html + * @return string Html */ public function getCredits( $cnt, $showIfMax = true ) { wfProfileIn( __METHOD__ ); @@ -104,7 +104,7 @@ * Get a list of contributors of $article * @param int $cnt Maximum list of contributors to show * @param bool $showIfMax Whether to contributors if there more than $cnt - * @return string html + * @return string Html */ protected function getContributors( $cnt, $showIfMax ) { global $wgHiddenPrefs; diff --git a/includes/actions/HistoryAction.php b/includes/actions/HistoryAction.php index 7b3a356..4992313 100644 --- a/includes/actions/HistoryAction.php +++ b/includes/actions/HistoryAction.php @@ -251,7 +251,7 @@ /** * Output a subscription feed listing recent edits to this page. * - * @param string $type feed type + * @param string $type Feed type */ function feed( $type ) { global $wgFeedClasses, $wgFeedLimit; @@ -303,7 +303,7 @@ * Borrows Recent Changes' feed generation functions for formatting; * includes a diff to the previous revision (if any). * - * @param stdClass|array $row database row + * @param stdClass|array $row Database row * @return FeedItem */ function feedItem( $row ) { diff --git a/includes/api/ApiDelete.php b/includes/api/ApiDelete.php index 2fa4518..35555bc 100644 --- a/includes/api/ApiDelete.php +++ b/includes/api/ApiDelete.php @@ -104,8 +104,8 @@ * * @param Page|WikiPage $page Page or WikiPage object to work on * @param User $user User doing the action - * @param string $token delete token (same as edit token) - * @param string|null $reason reason for the deletion. Autogenerated if null + * @param string $token Delete token (same as edit token) + * @param string|null $reason Reason for the deletion. Autogenerated if null * @return Status|array */ public static function delete( Page $page, User $user, $token, &$reason = null ) { diff --git a/includes/api/ApiFormatBase.php b/includes/api/ApiFormatBase.php index 848d129..5d20005 100644 --- a/includes/api/ApiFormatBase.php +++ b/includes/api/ApiFormatBase.php @@ -354,7 +354,7 @@ * Call this method to initialize output data. See execute() * @param ApiResult $result * @param object $feed An instance of one of the $wgFeedClasses classes - * @param array $feedItems of FeedItem objects + * @param array $feedItems Array of FeedItem objects */ public static function setResult( $result, $feed, $feedItems ) { // Store output in the Result data. diff --git a/includes/api/ApiImageRotate.php b/includes/api/ApiImageRotate.php index c932a74..fa7524f 100644 --- a/includes/api/ApiImageRotate.php +++ b/includes/api/ApiImageRotate.php @@ -26,10 +26,10 @@ /** * Add all items from $values into the result - * @param array $result output - * @param array $values values to add - * @param string $flag the name of the boolean flag to mark this element - * @param string $name if given, name of the value + * @param array $result Output + * @param array $values Values to add + * @param string $flag The name of the boolean flag to mark this element + * @param string $name If given, name of the value */ private static function addValues( array &$result, $values, $flag = null, $name = null ) { foreach ( $values as $val ) { diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php index a5873e6..4a75f3c 100644 --- a/includes/api/ApiMain.php +++ b/includes/api/ApiMain.php @@ -861,7 +861,7 @@ /** * Check POST for external response and setup result printer * @param ApiBase $module An Api module - * @param array $params an array with the request parameters + * @param array $params An array with the request parameters */ protected function setupExternalResponse( $module, $params ) { if ( !$this->getRequest()->wasPosted() && $module->mustBePosted() ) { diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index f955ea6..94727cb 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -180,7 +180,7 @@ /** * Get the array mapping module names to class names * @deprecated since 1.21, use getModuleManager()'s methods instead - * @return array array(modulename => classname) + * @return array Array(modulename => classname) */ public function getModules() { wfDeprecated( __METHOD__, '1.21' ); @@ -191,7 +191,7 @@ /** * Get the generators array mapping module names to class names * @deprecated since 1.21, list of generators is maintained by ApiPageSet - * @return array array(modulename => classname) + * @return array Array(modulename => classname) */ public function getGenerators() { wfDeprecated( __METHOD__, '1.21' ); diff --git a/includes/api/ApiQueryImageInfo.php b/includes/api/ApiQueryImageInfo.php index 4b49a80..a214610 100644 --- a/includes/api/ApiQueryImageInfo.php +++ b/includes/api/ApiQueryImageInfo.php @@ -534,7 +534,7 @@ * * If this is >= TRANSFORM_LIMIT, you should probably stop processing images. * - * @return int count + * @return int Count */ static function getTransformCount() { return self::$transformCount; diff --git a/includes/api/ApiQueryRecentChanges.php b/includes/api/ApiQueryRecentChanges.php index 44d287b..cb4e3e8 100644 --- a/includes/api/ApiQueryRecentChanges.php +++ b/includes/api/ApiQueryRecentChanges.php @@ -47,7 +47,7 @@ * Get an array mapping token names to their handler functions. * The prototype for a token function is func($pageid, $title, $rc) * it should return a token or false (permission denied) - * @return array array(tokenname => function) + * @return array Array(tokenname => function) */ protected function getTokenFunctions() { // Don't call the hooks twice @@ -105,7 +105,7 @@ /** * Sets internal state to include the desired properties in the output. - * @param array $prop associative array of properties, only keys are used here + * @param array $prop Associative array of properties, only keys are used here */ public function initProperties( $prop ) { $this->fld_comment = isset( $prop['comment'] ); diff --git a/includes/cache/CacheDependency.php b/includes/cache/CacheDependency.php index 15d7c89..9b48ecb 100644 --- a/includes/cache/CacheDependency.php +++ b/includes/cache/CacheDependency.php @@ -156,7 +156,7 @@ /** * Create a file dependency * - * @param string $filename the name of the file, preferably fully qualified + * @param string $filename The name of the file, preferably fully qualified * @param null|bool|int $timestamp The unix last modified timestamp, or false if the * file does not exist. If omitted, the timestamp will be loaded from * the file. diff --git a/includes/cache/LocalisationCache.php b/includes/cache/LocalisationCache.php index 91fb878..cf87129 100644 --- a/includes/cache/LocalisationCache.php +++ b/includes/cache/LocalisationCache.php @@ -536,7 +536,7 @@ /** * Read a JSON file containing localisation messages. * @param string $fileName Name of file to read - * @throws MWException if there is a syntax error in the JSON file + * @throws MWException If there is a syntax error in the JSON file * @return array Array with a 'messages' key, or empty array if the file doesn't exist */ public function readJSONFile( $fileName ) { @@ -1157,7 +1157,7 @@ /** @var DatabaseBase */ private $dbw; - /** @var Array */ + /** @var array */ private $batch = array(); private $readOnly = false; diff --git a/includes/cache/MessageCache.php b/includes/cache/MessageCache.php index e5afd21..e34961c 100644 --- a/includes/cache/MessageCache.php +++ b/includes/cache/MessageCache.php @@ -699,9 +699,9 @@ * - If boolean and false, create object from the current users language * - If boolean and true, create object from the wikis content language * - If language object, use it as given - * @param bool $isFullKey specifies whether $key is a two part key "msg/lang". + * @param bool $isFullKey Specifies whether $key is a two part key "msg/lang". * - * @throws MWException when given an invalid key + * @throws MWException When given an invalid key * @return string|bool False if the message doesn't exist, otherwise the * message (which can be empty) */ diff --git a/includes/changes/RecentChange.php b/includes/changes/RecentChange.php index 8fa6ed9..cfebf40 100644 --- a/includes/changes/RecentChange.php +++ b/includes/changes/RecentChange.php @@ -179,7 +179,7 @@ /** * Obtain the recent change with a given rc_id value * - * @param int $rcid rc_id value to retrieve + * @param int $rcid The rc_id value to retrieve * @return RecentChange */ public static function newFromId( $rcid ) { diff --git a/includes/clientpool/RedisConnectionPool.php b/includes/clientpool/RedisConnectionPool.php index d2c504a..dc95727 100644 --- a/includes/clientpool/RedisConnectionPool.php +++ b/includes/clientpool/RedisConnectionPool.php @@ -346,7 +346,7 @@ * Adjust or reset the connection handle read timeout value * * @param Redis $conn - * @param integer $timeout Optional + * @param int $timeout Optional */ public function resetTimeout( Redis $conn, $timeout = null ) { $conn->setOption( Redis::OPT_READ_TIMEOUT, $timeout ?: $this->readTimeout ); diff --git a/includes/config/ConfigFactory.php b/includes/config/ConfigFactory.php index b09316b..ff2f403 100644 --- a/includes/config/ConfigFactory.php +++ b/includes/config/ConfigFactory.php @@ -57,8 +57,8 @@ * Register a new config factory function * Will override if it's already registered * @param string $name - * @param callable $callback that takes this ConfigFactory as an argument - * @throws InvalidArgumentException if an invalid callback is provided + * @param callable $callback That takes this ConfigFactory as an argument + * @throws InvalidArgumentException If an invalid callback is provided */ public function register( $name, $callback ) { if ( !is_callable( $callback ) ) { @@ -70,10 +70,10 @@ /** * Create a given Config using the registered callback for $name. * If an object was already created, the same Config object is returned. - * @param string $name of the extension/component you want a Config object for + * @param string $name Name of the extension/component you want a Config object for * 'main' is used for core - * @throws ConfigException if a factory function isn't registered for $name - * @throws UnexpectedValueException if the factory function returns a non-Config object + * @throws ConfigException If a factory function isn't registered for $name + * @throws UnexpectedValueException If the factory function returns a non-Config object * @return Config */ public function makeConfig( $name ) { diff --git a/includes/config/GlobalVarConfig.php b/includes/config/GlobalVarConfig.php index 175a76e..0841a00 100644 --- a/includes/config/GlobalVarConfig.php +++ b/includes/config/GlobalVarConfig.php @@ -80,7 +80,7 @@ * * @param string $prefix Prefix to use on the variable * @param string $name Variable name without prefix - * @param mixed $value value to set + * @param mixed $value Value to set */ protected function setWithPrefix( $prefix, $name, $value ) { $GLOBALS[$prefix . $name] = $value; diff --git a/includes/content/CssContentHandler.php b/includes/content/CssContentHandler.php index 85059a8..fd326f0 100644 --- a/includes/content/CssContentHandler.php +++ b/includes/content/CssContentHandler.php @@ -65,7 +65,7 @@ * @param Title $title * @param Content $content * - * @return Language wfGetLangObj( 'en' ) + * @return Language Return of wfGetLangObj( 'en' ) * * @see ContentHandler::getPageLanguage() */ @@ -79,7 +79,7 @@ * @param Title $title * @param Content $content * - * @return Language wfGetLangObj( 'en' ) + * @return Language Return of wfGetLangObj( 'en' ) * * @see ContentHandler::getPageViewLanguage() */ diff --git a/includes/content/JavaScriptContentHandler.php b/includes/content/JavaScriptContentHandler.php index 2e98976..122003f 100644 --- a/includes/content/JavaScriptContentHandler.php +++ b/includes/content/JavaScriptContentHandler.php @@ -65,7 +65,7 @@ * @param Title $title * @param Content $content * - * @return Language wfGetLangObj( 'en' ) + * @return Language Return of wfGetLangObj( 'en' ) * * @see ContentHandler::getPageLanguage() */ @@ -79,7 +79,7 @@ * @param Title $title * @param Content $content * - * @return Language wfGetLangObj( 'en' ) + * @return Language Return of wfGetLangObj( 'en' ) * * @see ContentHandler::getPageViewLanguage() */ diff --git a/includes/content/MessageContent.php b/includes/content/MessageContent.php index b601344..abaac53 100644 --- a/includes/content/MessageContent.php +++ b/includes/content/MessageContent.php @@ -126,7 +126,7 @@ } /** - * @return Content. A copy of this object + * @return Content A copy of this object * * @see Content::copy */ diff --git a/includes/content/WikitextContent.php b/includes/content/WikitextContent.php index 8163b73..237029b 100644 --- a/includes/content/WikitextContent.php +++ b/includes/content/WikitextContent.php @@ -315,7 +315,7 @@ * @param int $revId Revision to pass to the parser (default: null) * @param ParserOptions $options (default: null) * @param bool $generateHtml (default: true) - * @param &$output ParserOutput representing the HTML form of the text, + * @param ParserOutput &$output ParserOutput representing the HTML form of the text, * may be manipulated or replaced. */ protected function fillParserOutput( Title $title, $revId, diff --git a/includes/context/DerivativeContext.php b/includes/context/DerivativeContext.php index d78f420..b8966f0c 100644 --- a/includes/context/DerivativeContext.php +++ b/includes/context/DerivativeContext.php @@ -296,8 +296,7 @@ * it would set only the original context, and not take * into account any changes. * - * @param String Message name - * @param Variable number of message arguments + * @param mixed $args,... Arguments to wfMessage * @return Message */ public function msg() { diff --git a/includes/db/Database.php b/includes/db/Database.php index e13c053..86c2616 100644 --- a/includes/db/Database.php +++ b/includes/db/Database.php @@ -1900,7 +1900,7 @@ * DatabaseBase::tableName(). * @param array $a Array of rows to insert * @param string $fname Calling function name (use __METHOD__) for logs/profiling - * @param array $options of options + * @param array $options Array of options * * @return bool */ @@ -2095,11 +2095,11 @@ * Build a partial where clause from a 2-d array such as used for LinkBatch. * The keys on each level may be either integers or strings. * - * @param array $data organized as 2-d + * @param array $data Organized as 2-d * array(baseKeyVal => array(subKeyVal => [ignored], ...), ...) * @param string $baseKey Field name to match the base-level keys to (eg 'pl_namespace') * @param string $subKey Field name to match the sub-level keys to (eg 'pl_title') - * @return string|bool string SQL fragment, or false if no items in array. + * @return string|bool SQL fragment, or false if no items in array */ public function makeWhereFrom2d( $data, $baseKey, $subKey ) { $conds = array(); @@ -2385,7 +2385,7 @@ /** * Gets an array of aliased table names * - * @param array $tables array( [alias] => table ) + * @param array $tables Array( [alias] => table ) * @return string[] See tableNameWithAlias() */ public function tableNamesWithAlias( $tables ) { @@ -2419,7 +2419,7 @@ /** * Gets an array of aliased field names * - * @param array $fields array( [alias] => field ) + * @param array $fields Array( [alias] => field ) * @return string[] See fieldNameWithAlias() */ public function fieldNamesWithAlias( $fields ) { @@ -2920,9 +2920,9 @@ * DELETE query wrapper. * * @param array $table Table name - * @param string|array $conds of conditions. See $conds in DatabaseBase::select() + * @param string|array $conds Array of conditions. See $conds in DatabaseBase::select() * for the format. Use $conds == "*" to delete all rows - * @param string $fname name of the calling function + * @param string $fname Name of the calling function * @throws DBUnexpectedError * @return bool|ResultWrapper */ @@ -4152,7 +4152,7 @@ /** * Encode an expiry time into the DBMS dependent format * - * @param string $expiry timestamp for expiry, or the 'infinity' string + * @param string $expiry Timestamp for expiry, or the 'infinity' string * @return string */ public function encodeExpiry( $expiry ) { diff --git a/includes/db/DatabaseMssql.php b/includes/db/DatabaseMssql.php index be01f1a..c2f5b6d 100644 --- a/includes/db/DatabaseMssql.php +++ b/includes/db/DatabaseMssql.php @@ -743,7 +743,7 @@ /** * UPDATE wrapper. Takes a condition array and a SET array. * - * @param string $table name of the table to UPDATE. This will be passed through + * @param string $table Name of the table to UPDATE. This will be passed through * DatabaseBase::tableName(). * * @param array $values An array of values to SET. For each array element, @@ -787,7 +787,7 @@ /** * Makes an encoded list of strings from an array - * @param array $a containing the data + * @param array $a Containing the data * @param int $mode Constant * - LIST_COMMA: comma separated, no field names * - LIST_AND: ANDed WHERE clause (without the WHERE). See @@ -1177,7 +1177,7 @@ } /** - * @param array $options an associative array of options to be turned into + * @param array $options An associative array of options to be turned into * an SQL query, valid keys are listed in the function. * @return array */ diff --git a/includes/db/DatabaseMysqlBase.php b/includes/db/DatabaseMysqlBase.php index cf37736..5ad7c78 100644 --- a/includes/db/DatabaseMysqlBase.php +++ b/includes/db/DatabaseMysqlBase.php @@ -806,8 +806,8 @@ /** * Check to see if a named lock is available. This is non-blocking. * - * @param string $lockName name of lock to poll - * @param string $method name of method calling us + * @param string $lockName Name of lock to poll + * @param string $method Name of method calling us * @return bool * @since 1.20 */ @@ -901,7 +901,7 @@ /** * @param bool $value - * @return mixed null|bool|ResultWrapper + * @return null|bool|ResultWrapper */ public function setBigSelects( $value = true ) { if ( $value === 'default' ) { @@ -1241,7 +1241,7 @@ /** @var string */ public $file; - /** @var int timestamp */ + /** @var int Timestamp */ public $pos; function __construct( $file, $pos ) { diff --git a/includes/db/DatabaseOracle.php b/includes/db/DatabaseOracle.php index 7686010..f031f78 100644 --- a/includes/db/DatabaseOracle.php +++ b/includes/db/DatabaseOracle.php @@ -1000,7 +1000,7 @@ } /** - * @return string wikitext of a link to the server software's web site + * @return string Wikitext of a link to the server software's web site */ public function getSoftwareLink() { return '[{{int:version-db-oracle-url}} Oracle]'; diff --git a/includes/db/DatabasePostgres.php b/includes/db/DatabasePostgres.php index 49dcbc0..f5fdca1 100644 --- a/includes/db/DatabasePostgres.php +++ b/includes/db/DatabasePostgres.php @@ -1235,7 +1235,7 @@ * @see getSearchPath() * @see setSearchPath() * @since 1.19 - * @return array list of actual schemas for the current sesson + * @return array List of actual schemas for the current sesson */ function getSchemas() { $res = $this->query( "SELECT current_schemas(false)", __METHOD__ ); @@ -1322,7 +1322,7 @@ * Return schema name fore core MediaWiki tables * * @since 1.19 - * @return string core schema name + * @return string Core schema name */ function getCoreSchema() { return $this->mCoreSchema; @@ -1546,7 +1546,7 @@ /** * Various select options * - * @param array $options an associative array of options to be turned into + * @param array $options An associative array of options to be turned into * an SQL query, valid keys are listed in the function. * @return array */ diff --git a/includes/db/DatabaseSqlite.php b/includes/db/DatabaseSqlite.php index af687b2..9a03a33 100644 --- a/includes/db/DatabaseSqlite.php +++ b/includes/db/DatabaseSqlite.php @@ -666,7 +666,7 @@ } /** - * @return string wikitext of a link to the server software's web site + * @return string Wikitext of a link to the server software's web site */ public function getSoftwareLink() { return "[{{int:version-db-sqlite-url}} SQLite]"; diff --git a/includes/db/DatabaseUtility.php b/includes/db/DatabaseUtility.php index 36d218a..3923241 100644 --- a/includes/db/DatabaseUtility.php +++ b/includes/db/DatabaseUtility.php @@ -107,7 +107,7 @@ /** @var int */ protected $pos = 0; - /** @var */ + /** @var object|null */ protected $currentRow = null; /** diff --git a/includes/db/IORMTable.php b/includes/db/IORMTable.php index ab1ab79..bf49bbb 100644 --- a/includes/db/IORMTable.php +++ b/includes/db/IORMTable.php @@ -107,7 +107,7 @@ * @param string|null $functionName * * @return ORMResult The result set - * @throws DBQueryError if the query failed (even if the database was in ignoreErrors mode) + * @throws DBQueryError If the query failed (even if the database was in ignoreErrors mode) */ public function select( $fields = null, array $conditions = array(), array $options = array(), $functionName = null ); @@ -123,7 +123,7 @@ * @param array $options * @param string|null $functionName * - * @return array of self + * @return array Array of self */ public function selectObjects( $fields = null, array $conditions = array(), array $options = array(), $functionName = null ); @@ -139,7 +139,7 @@ * @param null|string $functionName * * @return ResultWrapper - * @throws DBQueryError if the query failed (even if the database was in ignoreErrors mode) + * @throws DBQueryError If the query failed (even if the database was in ignoreErrors mode) */ public function rawSelect( $fields = null, array $conditions = array(), array $options = array(), $functionName = null ); @@ -164,7 +164,7 @@ * @param bool $collapse Set to false to always return each result row as associative array. * @param string|null $functionName * - * @return array of array + * @return array Array of array */ public function selectFields( $fields = null, array $conditions = array(), array $options = array(), $collapse = true, $functionName = null ); diff --git a/includes/db/LBFactory.php b/includes/db/LBFactory.php index 168d846..73456e2 100644 --- a/includes/db/LBFactory.php +++ b/includes/db/LBFactory.php @@ -59,7 +59,7 @@ * Returns the LBFactory class to use and the load balancer configuration. * * @param array $config (e.g. $wgLBFactoryConf) - * @return string class name + * @return string Class name */ public static function getLBFactoryClass( array $config ) { // For configuration backward compatibility after removing @@ -142,7 +142,7 @@ /** * Get a cached (tracked) load balancer for external storage * - * @param string $cluster external storage cluster, or false for core + * @param string $cluster External storage cluster, or false for core * @param bool|string $wiki Wiki ID, or false for the current wiki * @return LoadBalancer */ diff --git a/includes/db/LBFactoryMulti.php b/includes/db/LBFactoryMulti.php index bda3dd6..bac9652 100644 --- a/includes/db/LBFactoryMulti.php +++ b/includes/db/LBFactoryMulti.php @@ -263,7 +263,7 @@ } /** - * @param string $cluster external storage cluster, or false for core + * @param string $cluster External storage cluster, or false for core * @param bool|string $wiki Wiki ID, or false for the current wiki * @return LoadBalancer */ diff --git a/includes/db/LoadBalancer.php b/includes/db/LoadBalancer.php index 01440f4..0379e86 100644 --- a/includes/db/LoadBalancer.php +++ b/includes/db/LoadBalancer.php @@ -43,7 +43,7 @@ private $mLoadMonitorClass, $mLoadMonitor; /** - * @param array $params with keys: + * @param array $params Array with keys: * servers Required. Array of server info structures. * loadMonitor Name of a class used to fetch server lag and load. * @throws MWException diff --git a/includes/db/ORMTable.php b/includes/db/ORMTable.php index 51b81da..24fa68c 100644 --- a/includes/db/ORMTable.php +++ b/includes/db/ORMTable.php @@ -220,8 +220,8 @@ * @param array $options * @param string|null $functionName * - * @return array of row objects - * @throws DBQueryError if the query failed (even if the database was in ignoreErrors mode). + * @return array Array of row objects + * @throws DBQueryError If the query failed (even if the database was in ignoreErrors mode). */ public function selectObjects( $fields = null, array $conditions = array(), array $options = array(), $functionName = null @@ -247,7 +247,7 @@ * @param array $options * @param null|string $functionName * @return ResultWrapper - * @throws DBQueryError if the query failed (even if the database was in + * @throws DBQueryError If the query failed (even if the database was in * ignoreErrors mode). */ public function rawSelect( $fields = null, array $conditions = array(), @@ -314,7 +314,7 @@ * @param bool $collapse Set to false to always return each result row as associative array. * @param string|null $functionName * - * @return array of array + * @return array Array of array */ public function selectFields( $fields = null, array $conditions = array(), array $options = array(), $collapse = true, $functionName = null @@ -648,7 +648,7 @@ * * @see LoadBalancer::reuseConnection * - * @param DatabaseBase $db the database + * @param DatabaseBase $db * * @since 1.20 */ diff --git a/includes/deferred/DataUpdate.php b/includes/deferred/DataUpdate.php index 8d4ee84..ed12c60 100644 --- a/includes/deferred/DataUpdate.php +++ b/includes/deferred/DataUpdate.php @@ -73,7 +73,7 @@ * This allows for limited transactional logic across multiple backends for storing * secondary data. * - * @param array $updates a list of DataUpdate instances + * @param array $updates A list of DataUpdate instances * @throws Exception|null */ public static function runUpdates( $updates ) { diff --git a/includes/deferred/DeferredUpdates.php b/includes/deferred/DeferredUpdates.php index 5cf0d2b..2178281 100644 --- a/includes/deferred/DeferredUpdates.php +++ b/includes/deferred/DeferredUpdates.php @@ -76,7 +76,7 @@ /** * Do any deferred updates and clear the list * - * @param string $commit set to 'commit' to commit after every update to + * @param string $commit Set to 'commit' to commit after every update to * prevent lock contention */ public static function doUpdates( $commit = '' ) { diff --git a/includes/deferred/LinksUpdate.php b/includes/deferred/LinksUpdate.php index 631f739..45d2664 100644 --- a/includes/deferred/LinksUpdate.php +++ b/includes/deferred/LinksUpdate.php @@ -31,7 +31,7 @@ /** @var int Page ID of the article linked from */ public $mId; - /** @var Title object of the article linked from */ + /** @var Title Title object of the article linked from */ public $mTitle; /** @var ParserOutput */ @@ -52,7 +52,7 @@ /** @var array Map of category names to sort keys */ public $mCategories; - /** @var array ap of language codes to titles */ + /** @var array Map of language codes to titles */ public $mInterlangs; /** @var array Map of arbitrary name to value */ diff --git a/includes/deferred/SqlDataUpdate.php b/includes/deferred/SqlDataUpdate.php index 14bae23..9c58503 100644 --- a/includes/deferred/SqlDataUpdate.php +++ b/includes/deferred/SqlDataUpdate.php @@ -46,7 +46,7 @@ /** * Constructor * - * @param bool $withTransaction whether this update should be wrapped in a + * @param bool $withTransaction Whether this update should be wrapped in a * transaction (default: true). A transaction is only started if no * transaction is already in progress, see beginTransaction() for details. */ diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php index 61eb760..661330d 100644 --- a/includes/diff/DifferenceEngine.php +++ b/includes/diff/DifferenceEngine.php @@ -98,9 +98,9 @@ /** * Constructor - * @param IContextSource $context context to use, anything else will be ignored - * @param int $old old ID we want to show and diff with. - * @param string|int $new either revision ID or 'prev' or 'next'. Default: 0. + * @param IContextSource $context Context to use, anything else will be ignored + * @param int $old Old ID we want to show and diff with. + * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0. * @param int $rcid Deprecated, no longer used! * @param bool $refreshCache If set, refreshes the diff cache * @param bool $unhide If set, allow viewing deleted revs @@ -823,8 +823,8 @@ * * @todo move this to TextDifferenceEngine, make DifferenceEngine abstract. At some point. * - * @param string $otext old text, must be already segmented - * @param string $ntext new text, must be already segmented + * @param string $otext Old text, must be already segmented + * @param string $ntext New text, must be already segmented * * @return bool|string */ -- To view, visit https://gerrit.wikimedia.org/r/149062 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I7b65fe04db431342cc58b469dc48f41a50c4e891 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/core Gerrit-Branch: master Gerrit-Owner: Umherirrender <umherirrender_de...@web.de> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits