wikimedia / mediawiki

includes/libs/rdbms/database/Database.php

Doc Comments +18 added lines, -5 removed lines

@@ -650,7 +650,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -662,7 +662,7 @@ 
 	}
 
 	/**
-	 * @return string|bool Last PHP error for this DB (typically connection errors)
+	 * @return string|false Last PHP error for this DB (typically connection errors)
 	 */
 	protected function getLastPHPError() {
 		if ( $this->mPHPError ) {
@@ -770,7 +770,7 @@ 
 	}
 
 	/**
-	 * @param $sql
+	 * @param string $sql
 	 * @return string|null
 	 */
 	protected function getQueryVerb( $sql ) {
@@ -917,6 +917,12 @@ 
 		return $res;
 	}
 
+	/**
+	 * @param string $sql
+	 * @param string $commentedSql
+	 * @param boolean $isWrite
+	 * @param string $fname
+	 */
 	private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
 		$isMaster = !is_null( $this->getLBInfo( 'master' ) );
 		# generalizeSQL() will probably cut down the query to reasonable
@@ -998,6 +1004,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string $sql
+	 * @param boolean $priorWritesPending
+	 */
 	private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
 		# Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
 		# Dropped connections also mean that named locks are automatically released.
@@ -1117,7 +1127,7 @@ 
 	 *
 	 * @param array $options Associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 * @see Database::select()
 	 */
 	protected function makeSelectOptions( $options ) {
@@ -2288,6 +2298,9 @@ 
 		return $this->insert( $destTable, $rows, $fname, $insertOptions );
 	}
 
+	/**
+	 * @param string $destTable
+	 */
 	protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
 		$fname = __METHOD__,
 		$insertOptions = [], $selectOptions = []
@@ -3365,7 +3378,7 @@ 
 	}
 
 	/**
-	 * @return string|bool Reason this DB is read-only or false if it is not
+	 * @return string|false Reason this DB is read-only or false if it is not
 	 */
 	protected function getReadOnlyReason() {
 		$reason = $this->getLBInfo( 'readOnlyReason' );

includes/resourceloader/ResourceLoaderWikiModule.php

Doc Comments +4 added lines, -1 removed lines

@@ -137,7 +137,7 @@ 
 	 * NOTE: This ONLY works for getTitleInfo() and isKnownEmpty(), NOT FOR ANYTHING ELSE.
 	 * In particular, it doesn't work for getContent() or getScript() etc.
 	 *
-	 * @return IDatabase|null
+	 * @return Database|null
 	 */
 	protected function getDB() {
 		return wfGetDB( DB_REPLICA );
@@ -277,6 +277,9 @@ 
 		return count( $revisions ) === 0;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	private function setTitleInfo( $key, array $titleInfo ) {
 		$this->titleInfo[$key] = $titleInfo;
 	}

includes/Title.php

Doc Comments +13 added lines, -14 removed lines

@@ -371,7 +371,7 @@ 
 	 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
 	 * whether to include page_content_model.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	protected static function getSelectFields() {
 		global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
@@ -566,7 +566,7 @@ 
 	 * Get the prefixed DB key associated with an ID
 	 *
 	 * @param int $id The page_id of the article
-	 * @return Title|null An object representing the article, or null if no such article was found
+	 * @return null|string An object representing the article, or null if no such article was found
 	 */
 	public static function nameOf( $id ) {
 		$dbr = wfGetDB( DB_REPLICA );
@@ -1104,7 +1104,6 @@ 
 	/**
 	 * Returns true if the title is inside one of the specified namespaces.
 	 *
-	 * @param int|int[] $namespaces,... The namespaces to check for
 	 * @return bool
 	 * @since 1.19
 	 */
@@ -1914,7 +1913,7 @@ 
 	 *   - quick  : does cheap permission checks from replica DBs (usable for GUI creation)
 	 *   - full   : does cheap and expensive checks possibly from a replica DB
 	 *   - secure : does cheap and expensive checks, using the master as needed
-	 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
+	 * @param string[] $ignoreErrors Array of Strings Set this to a list of message keys
 	 *   whose corresponding errors may be ignored.
 	 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
 	 */
@@ -2015,7 +2014,7 @@ 
 	 * Add the resulting error code to the errors array
 	 *
 	 * @param array $errors List of current errors
-	 * @param array $result Result of errors
+	 * @param string $result Result of errors
 	 *
 	 * @return array List of errors
 	 */
@@ -2410,7 +2409,7 @@ 
 	 *
 	 * @param string $action The action to check
 	 * @param bool $short Short circuit on first error
-	 * @return array List of errors
+	 * @return string[] List of errors
 	 */
 	private function missingPermissionError( $action, $short ) {
 		// We avoid expensive display logic for quickUserCan's and such
@@ -3934,7 +3933,7 @@ 
 	 * Get an associative array for selecting this title from
 	 * the "page" table
 	 *
-	 * @return array Array suitable for the $where parameter of DB::select()
+	 * @return IDatabase Array suitable for the $where parameter of DB::select()
 	 */
 	public function pageCond() {
 		if ( $this->mArticleID > 0 ) {
@@ -3950,7 +3949,7 @@ 
 	 *
 	 * @param int $revId Revision ID. Get the revision that was before this one.
 	 * @param int $flags Title::GAID_FOR_UPDATE
-	 * @return int|bool Old revision ID, or false if none exists
+	 * @return integer Old revision ID, or false if none exists
 	 */
 	public function getPreviousRevisionID( $revId, $flags = 0 ) {
 		$db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_REPLICA );
@@ -4090,8 +4089,8 @@ 
 	 * Get the number of revisions between the given revision.
 	 * Used for diffs and other things that really need it.
 	 *
-	 * @param int|Revision $old Old revision or rev ID (first before range)
-	 * @param int|Revision $new New revision or rev ID (first after range)
+	 * @param Revision $old Old revision or rev ID (first before range)
+	 * @param Revision $new New revision or rev ID (first after range)
 	 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
 	 * @return int Number of revisions between these revisions.
 	 */
@@ -4203,9 +4202,9 @@ 
 	 * Used for diffs and other things that really need it.
 	 *
 	 * @param int|Revision $old Old revision or rev ID (first before range by default)
-	 * @param int|Revision $new New revision or rev ID (first after range by default)
+	 * @param Revision $new New revision or rev ID (first after range by default)
 	 * @param int $limit Maximum number of authors
-	 * @param string|array $options (Optional): Single option, or an array of options:
+	 * @param string $options (Optional): Single option, or an array of options:
 	 *     'include_old' Include $old in the range; $new is excluded.
 	 *     'include_new' Include $new in the range; $old is excluded.
 	 *     'include_both' Include both $old and $new in the range.
@@ -4361,7 +4360,7 @@ 
 	/**
 	 * Get the default message text or false if the message doesn't exist
 	 *
-	 * @return string|bool
+	 * @return false|string
 	 */
 	public function getDefaultMessageText() {
 		global $wgContLang;
@@ -4812,7 +4811,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	public function __sleep() {
 		return [

includes/OutputPage.php

Doc Comments +16 added lines, -10 removed lines

@@ -661,7 +661,7 @@ 
 	 * Add one or more head items to the output
 	 *
 	 * @since 1.28
-	 * @param string|string[] $value Raw HTML
+	 * @param string|string[] $values Raw HTML
 	 */
 	public function addHeadItems( $values ) {
 		$this->mHeadItems = array_merge( $this->mHeadItems, (array)$values );
@@ -978,7 +978,7 @@ 
 	/**
 	 * Replace the subtitle with $str
 	 *
-	 * @param string|Message $str New value of the subtitle. String should be safe HTML.
+	 * @param string $str New value of the subtitle. String should be safe HTML.
 	 */
 	public function setSubtitle( $str ) {
 		$this->clearSubtitle();
@@ -1596,7 +1596,7 @@ 
 	/**
 	 * Set the displayed file version
 	 *
-	 * @param File|bool $file
+	 * @param File $file
 	 * @return mixed Previous value
 	 */
 	public function setFileVersion( $file ) {
@@ -1940,7 +1940,7 @@ 
 	 * the TTL is higher the older the $mtime timestamp is. Essentially, the
 	 * TTL is 90% of the age of the object, subject to the min and max.
 	 *
-	 * @param string|integer|float|bool|null $mtime Last-Modified timestamp
+	 * @param false|string $mtime Last-Modified timestamp
 	 * @param integer $minTTL Mimimum TTL in seconds [default: 1 minute]
 	 * @param integer $maxTTL Maximum TTL in seconds [default: $wgSquidMaxage]
 	 * @return integer TTL in seconds
@@ -1977,7 +1977,7 @@ 
 	/**
 	 * Get the list of cookies that will influence on the cache
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheVaryCookies() {
 		static $cookies;
@@ -2368,7 +2368,7 @@ 
 	 * indexing, clear the current text and redirect, set the page's title
 	 * and optionally an custom HTML title (content of the "<title>" tag).
 	 *
-	 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
+	 * @param Message $pageTitle Will be passed directly to setPageTitle()
 	 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
 	 *                   optional, if not passed the "<title>" attribute will be
 	 *                   based on $pageTitle
@@ -2394,8 +2394,8 @@ 
 	 * showErrorPage( 'titlemsg', $messageObject );
 	 * showErrorPage( $titleMessageObject, $messageObject );
 	 *
-	 * @param string|Message $title Message key (string) for page title, or a Message object
-	 * @param string|Message $msg Message key (string) for page text, or a Message object
+	 * @param string $title Message key (string) for page title, or a Message object
+	 * @param string $msg Message key (string) for page text, or a Message object
 	 * @param array $params Message parameters; ignored if $msg is a Message object
 	 */
 	public function showErrorPage( $title, $msg, $params = [] ) {
@@ -2596,6 +2596,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function showFatalError( $message ) {
 		$this->prepareErrorPage( $this->msg( 'internalerror' ) );
 
@@ -2614,6 +2617,9 @@ 
 		$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function showFileDeleteError( $name ) {
 		$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
 	}
@@ -2640,7 +2646,7 @@ 
 	 * Add a "return to" link pointing to a specified title,
 	 * or the title indicated in the request, or else the main page
 	 *
-	 * @param mixed $unused
+	 * @param null|boolean $unused
 	 * @param Title|string $returnto Title or String to return to
 	 * @param string $returntoquery Query string for the return to link
 	 */
@@ -3668,7 +3674,7 @@ 
 	 * Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
 	 *
 	 * @since 1.27
-	 * @param string $remotePath URL path prefix that points to $localPath
+	 * @param string $remotePathPrefix URL path prefix that points to $localPath
 	 * @param string $localPath File directory exposed at $remotePath
 	 * @param string $file Path to target file relative to $localPath
 	 * @return string URL

includes/libs/StatusValue.php

Doc Comments +3 added lines, -3 removed lines

@@ -246,7 +246,7 @@ 
 	/**
 	 * Returns true if the specified message is present as a warning or error
 	 *
-	 * @param string|MessageSpecifier $message Message key or object to search for
+	 * @param string $message Message key or object to search for
 	 *
 	 * @return bool
 	 */
@@ -274,8 +274,8 @@ 
 	 * Note, due to the lack of tools for comparing IStatusMessage objects, this
 	 * function will not work when using such an object as the search parameter.
 	 *
-	 * @param MessageSpecifier|string $source Message key or object to search for
-	 * @param MessageSpecifier|string $dest Replacement message key or object
+	 * @param string $source Message key or object to search for
+	 * @param string $dest Replacement message key or object
 	 * @return bool Return true if the replacement was done, false otherwise.
 	 */
 	public function replaceMessage( $source, $dest ) {

includes/GlobalFunctions.php

Doc Comments +14 added lines, -20 removed lines

@@ -235,7 +235,6 @@ 
  *   		[ 'y' ]
  *   	]
  *
- * @param array $array1,...
  * @return array
  */
 function wfMergeErrorArrays( /*...*/ ) {
@@ -262,8 +261,8 @@ 
  *
  * @param array $array The array.
  * @param array $insert The array to insert.
- * @param mixed $after The key to insert after
- * @return array
+ * @param string $after The key to insert after
+ * @return string[]
  */
 function wfArrayInsertAfter( array $array, array $insert, $after ) {
 	// Find the offset of the element to insert after.
@@ -1302,7 +1301,7 @@ 
 /**
  * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
  *
- * @return string|bool String when in read-only mode; false otherwise
+ * @return string|false String when in read-only mode; false otherwise
  * @since 1.27
  */
 function wfConfiguredReadOnlyReason() {
@@ -1377,7 +1376,6 @@ 
  * This function replaces all old wfMsg* functions.
  *
  * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
- * @param mixed $params,... Normal message parameters
  * @return Message
  *
  * @since 1.17
@@ -1398,7 +1396,6 @@ 
  * for the first message which is non-empty. If all messages are empty then an
  * instance of the first message key is returned.
  *
- * @param string|string[] $keys,... Message keys
  * @return Message
  *
  * @since 1.18
@@ -1631,7 +1628,7 @@ 
  * Use this when considering to send a gzip-encoded response to the client.
  *
  * @param bool $force Forces another check even if we already have a cached result.
- * @return bool
+ * @return null|boolean
  */
 function wfClientAcceptsGzip( $force = false ) {
 	static $result = null;
@@ -1719,7 +1716,7 @@ 
  * @param mixed $dest
  * @param mixed $source
  * @param bool $force
- * @return mixed
+ * @return string
  */
 function wfSetVar( &$dest, $source, $force = false ) {
 	$temp = $dest;
@@ -1769,7 +1766,7 @@ 
 /**
  * Provide a simple HTTP error.
  *
- * @param int|string $code
+ * @param integer $code
  * @param string $label
  * @param string $desc
  */
@@ -2002,8 +1999,8 @@ 
  *
  * @param mixed $outputtype A timestamp in one of the supported formats, the
  *   function will autodetect which format is supplied and act accordingly.
- * @param mixed $ts Optional timestamp to convert, default 0 for the current time
- * @return string|bool String / false The same date in the format specified in $outputtype or false
+ * @param integer $ts Optional timestamp to convert, default 0 for the current time
+ * @return false|string String / false The same date in the format specified in $outputtype or false
  */
 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
 	$ret = MWTimestamp::convert( $outputtype, $ts );
@@ -2042,7 +2039,7 @@ 
 /**
  * Check if the operating system is Windows
  *
- * @return bool True if it's Windows, false otherwise.
+ * @return boolean|null True if it's Windows, false otherwise.
  */
 function wfIsWindows() {
 	static $isWindows = null;
@@ -2270,7 +2267,7 @@ 
 /**
  * Check if wfShellExec() is effectively disabled via php.ini config
  *
- * @return bool|string False or 'disabled'
+ * @return string|false False or 'disabled'
  * @since 1.22
  */
 function wfShellExecDisabled() {
@@ -2884,7 +2881,7 @@ 
  * @param int $pad Minimum number of digits in the output (pad with zeroes)
  * @param bool $lowercase Whether to output in lowercase or uppercase
  * @param string $engine Either "gmp", "bcmath", or "php"
- * @return string|bool The output number as a string, or false on error
+ * @return false|string The output number as a string, or false on error
  */
 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
 	$lowercase = true, $engine = 'auto'
@@ -2969,7 +2966,6 @@ 
 /**
  * Make a cache key for the local wiki.
  *
- * @param string $args,...
  * @return string
  */
 function wfMemcKey( /*...*/ ) {
@@ -2986,7 +2982,6 @@ 
  *
  * @param string $db
  * @param string $prefix
- * @param string $args,...
  * @return string
  */
 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
@@ -3006,7 +3001,6 @@ 
  * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
  *
  * @since 1.26
- * @param string $args,...
  * @return string
  */
 function wfGlobalCacheKey( /*...*/ ) {
@@ -3121,7 +3115,7 @@ 
  * Returns a valid placeholder object if the file does not exist.
  *
  * @param Title|string $title
- * @return LocalFile|null A File, or null if passed an invalid Title
+ * @return File|null A File, or null if passed an invalid Title
  */
 function wfLocalFile( $title ) {
 	return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
@@ -3326,7 +3320,7 @@ 
 /**
  * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
  *
- * @return int Prior time limit
+ * @return string Prior time limit
  * @since 1.26
  */
 function wfTransactionalTimeLimit() {
@@ -3462,7 +3456,7 @@ 
  *
  * @param string $format The format string (See php's docs)
  * @param string $data A binary string of binary data
- * @param int|bool $length The minimum length of $data or false. This is to
+ * @param integer $length The minimum length of $data or false. This is to
  *	prevent reading beyond the end of $data. false to disable the check.
  *
  * Also be careful when using this function to read unsigned 32 bit integer

includes/libs/rdbms/database/DatabasePostgres.php

Doc Comments +11 added lines

@@ -60,6 +60,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function hasConstraint( $name ) {
 		$conn = $this->getBindingHandle();
 
@@ -1070,6 +1073,10 @@ 
 		return $this->relationExists( $sequence, 'S', $schema );
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $trigger
+	 */
 	public function triggerExists( $table, $trigger ) {
 		$q = <<<SQL
 	SELECT 1 FROM pg_class, pg_namespace, pg_trigger
@@ -1093,6 +1100,10 @@ 
 		return $rows;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $rule
+	 */
 	public function ruleExists( $table, $rule ) {
 		$exists = $this->selectField( 'pg_rules', 'rulename',
 			[

maintenance/Maintenance.php

Doc Comments +3 added lines, -2 removed lines

@@ -295,7 +295,7 @@ 
 	/**
 	 * Get an argument.
 	 * @param int $argId The integer value (from zero) for the arg
-	 * @param mixed $default The default if it doesn't exist
+	 * @param string $default The default if it doesn't exist
 	 * @return mixed
 	 */
 	protected function getArg( $argId = 0, $default = null ) {
@@ -1346,6 +1346,7 @@ 
 	 * Unlock and lock again
 	 * Since the lock is low-priority, queued reads will be able to complete
 	 * @param Database &$db
+	 * @param Database $db
 	 */
 	private function relockSearchindex( $db ) {
 		$this->unlockSearchindex( $db );
@@ -1507,7 +1508,7 @@ 
 	 * is the width (number of columns) and the second element is the height
 	 * (number of rows).
 	 *
-	 * @return array
+	 * @return integer[]
 	 */
 	public static function getTermSize() {
 		$default = [ 80, 50 ];

includes/Status.php

Doc Comments +2 added lines, -2 removed lines

@@ -113,7 +113,7 @@ 
 	 *     1 => object(Status) # The Status with warning messages, only
 	 * ]
 	 *
-	 * @return Status[]
+	 * @return StatusValue[]
 	 */
 	public function splitByErrorType() {
 		list( $errorsOnlyStatus, $warningsOnlyStatus ) = parent::splitByErrorType();
@@ -225,7 +225,7 @@ 
 	 *
 	 * If both parameters are missing, and there is only one error, no bullet will be added.
 	 *
-	 * @param string|string[]|bool $shortContext A message name or an array of message names.
+	 * @param string $shortContext A message name or an array of message names.
 	 * @param string|string[]|bool $longContext A message name or an array of message names.
 	 * @param string|Language $lang Language to use for processing messages
 	 * @return Message