wikimedia / mediawiki

includes/collation/IcuCollation.php

Doc Comments +5 added lines, -1 removed lines

@@ -167,6 +167,9 @@ 
 	 */
 	const RECORD_LENGTH = 14;
 
+	/**
+	 * @param string $locale
+	 */
 	public function __construct( $locale ) {
 		if ( !extension_loaded( 'intl' ) ) {
 			throw new MWException( 'An ICU collation was requested, ' .
@@ -388,6 +391,7 @@ 
 
 	/**
 	 * @since 1.16.3
+	 * @param integer $index
 	 */
 	public function getLetterByIndex( $index ) {
 		if ( $this->firstLetterData === null ) {
@@ -449,7 +453,7 @@ 
 	 * currently in use, or false when it can't be determined.
 	 *
 	 * @since 1.21
-	 * @return string|bool
+	 * @return false|string
 	 */
 	static function getUnicodeVersionForICU() {
 		$icuVersion = IcuCollation::getICUVersion();

includes/site/SiteSQLStore.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
 	 *             instead.
 	 *
 	 * @param null $sitesTable IGNORED
-	 * @param null $cache IGNORED
+	 * @param null|BagOStuff $cache IGNORED
 	 *
 	 * @return SiteStore
 	 */

includes/OutputPage.php

Doc Comments +16 added lines, -10 removed lines

@@ -430,7 +430,7 @@ 
 	 * one is set.
 	 *
 	 * @since 1.25
-	 * @return bool|string
+	 * @return boolean
 	 */
 	public function getCanonicalUrl() {
 		return $this->mCanonicalUrl;
@@ -996,7 +996,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();
@@ -1610,7 +1610,7 @@ 
 	 * Get the timestamp of displayed revision.
 	 * This will be null if not filled by setRevisionTimestamp().
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function getRevisionTimestamp() {
 		return $this->mRevisionTimestamp;
@@ -1619,7 +1619,7 @@ 
 	/**
 	 * Set the displayed file version
 	 *
-	 * @param File|bool $file
+	 * @param File $file
 	 * @return mixed Previous value
 	 */
 	public function setFileVersion( $file ) {
@@ -1965,7 +1965,7 @@ 
 	/**
 	 * Get the list of cookies that will influence on the cache
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheVaryCookies() {
 		static $cookies;
@@ -2342,7 +2342,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
@@ -2368,8 +2368,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 = [] ) {
@@ -2565,6 +2565,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function showFatalError( $message ) {
 		$this->prepareErrorPage( $this->msg( 'internalerror' ) );
 
@@ -2583,6 +2586,9 @@ 
 		$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function showFileDeleteError( $name ) {
 		$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
 	}
@@ -2609,7 +2615,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
 	 */
@@ -3856,7 +3862,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/GlobalFunctions.php

Doc Comments +11 added lines, -17 removed lines

@@ -235,7 +235,6 @@ 
  *   		array( 'y' )
  *   	)
  *
- * @param array $array1,...
  * @return array
  */
 function wfMergeErrorArrays( /*...*/ ) {
@@ -1287,7 +1286,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() {
@@ -1362,7 +1361,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
@@ -1383,7 +1381,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
@@ -1614,7 +1611,7 @@ 
  * @todo FIXME: We may want to blacklist some broken browsers
  *
  * @param bool $force
- * @return bool Whereas client accept gzip compression
+ * @return null|boolean Whereas client accept gzip compression
  */
 function wfClientAcceptsGzip( $force = false ) {
 	static $result = null;
@@ -1750,7 +1747,7 @@ 
 /**
  * Provide a simple HTTP error.
  *
- * @param int|string $code
+ * @param integer $code
  * @param string $label
  * @param string $desc
  */
@@ -2032,8 +2029,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 string|false String / false The same date in the format specified in $outputtype or false
  */
 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
 	try {
@@ -2074,7 +2071,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;
@@ -2313,7 +2310,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() {
@@ -2927,7 +2924,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'
@@ -3012,7 +3009,6 @@ 
 /**
  * Make a cache key for the local wiki.
  *
- * @param string $args,...
  * @return string
  */
 function wfMemcKey( /*...*/ ) {
@@ -3029,7 +3025,6 @@ 
  *
  * @param string $db
  * @param string $prefix
- * @param string $args,...
  * @return string
  */
 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
@@ -3049,7 +3044,6 @@ 
  * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
  *
  * @since 1.26
- * @param string $args,...
  * @return string
  */
 function wfGlobalCacheKey( /*...*/ ) {
@@ -3151,7 +3145,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 );
@@ -3355,7 +3349,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() {
@@ -3491,7 +3485,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/logging/LogPager.php

Doc Comments +3 added lines

@@ -112,6 +112,9 @@
 		}
 	}
 
+	/**
+	 * @return string
+	 */
 	function stripParameters( $text ) {
 		if ( !$this->stripParametersEnabled ) {
 			return $text;

includes/skins/SkinTemplate.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function __call( $name, array $arguments ) {
 		if ( $this->conn === null ) {
 			list( $db, $groups, $wiki ) = $this->params;

includes/FauxRequest.php

Doc Comments +2 added lines, -2 removed lines

@@ -39,7 +39,7 @@ 
 	 * @param array $data Array of *non*-urlencoded key => value pairs, the
 	 *   fake GET/POST values
 	 * @param bool $wasPosted Whether to treat the data as POST
-	 * @param MediaWiki\Session\Session|array|null $session Session, session
+	 * @param MediaWiki\Session\Session|null $session Session, session
 	 *  data array, or null
 	 * @param string $protocol 'http' or 'https'
 	 * @throws MWException
@@ -126,7 +126,6 @@ 
 
 	/**
 	 * @since 1.26
-	 * @param string $name Unprefixed name of the cookie to set
 	 * @param string|null $value Value of the cookie to set
 	 * @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
 	 */
@@ -152,6 +151,7 @@ 
 
 	/**
 	 * @since 1.25
+	 * @param string $url
 	 */
 	public function setRequestURL( $url ) {
 		$this->requestUrl = $url;

includes/deferred/DeferredUpdates.php

Doc Comments +3 added lines

@@ -483,6 +483,9 @@
 		return Html::element( 'input', $realAttrs );
 	}
 
+	/**
+	 * @param string $mode
+	 */
 	function makeSearchButton( $mode, $attrs = array() ) {
 		switch ( $mode ) {
 			case 'go':

includes/installer/Installer.php

Doc Comments +7 added lines, -7 removed lines

@@ -359,7 +359,7 @@ 
 	 *
 	 * @param Config $baseConfig
 	 *
-	 * @return Config The config to use during installation.
+	 * @return null|Config The config to use during installation.
 	 */
 	public static function getInstallerConfig( Config $baseConfig ) {
 		$configOverrides = new HashConfig();
@@ -611,7 +611,7 @@ 
 	 * fake password in which case leave it as it is.
 	 *
 	 * @param string $name
-	 * @param mixed $value
+	 * @param string $value
 	 */
 	public function setPassword( $name, $value ) {
 		if ( !preg_match( '/^\*+$/', $value ) ) {
@@ -1256,7 +1256,7 @@ 
 	 *
 	 * If $versionInfo is not false, only executables with a version
 	 * matching $versionInfo[1] will be returned.
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function locateExecutable( $path, $names, $versionInfo = false ) {
 		if ( !is_array( $names ) ) {
@@ -1288,14 +1288,14 @@ 
 	/**
 	 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
 	 * @see locateExecutable()
-	 * @param array $names Array of possible names.
-	 * @param array|bool $versionInfo Default: false or array with two members:
+	 * @param string[] $names Array of possible names.
+	 * @param string[] $versionInfo Default: false or array with two members:
 	 *   0 => Command to run for version check, with $1 for the full executable name
 	 *   1 => String to compare the output with
 	 *
 	 * If $versionInfo is not false, only executables with a version
 	 * matching $versionInfo[1] will be returned.
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
 		foreach ( self::getPossibleBinPaths() as $path ) {
@@ -1314,7 +1314,7 @@ 
 	 * Used only by environment checks.
 	 * @param string $dir
 	 * @param string $url
-	 * @return bool|int|string
+	 * @return string|false
 	 */
 	public function dirIsExecutable( $dir, $url ) {
 		$scriptTypes = [