wikimedia / mediawiki

includes/filerepo/file/ForeignAPIFile.php

Doc Comments +4 added lines, -4 removed lines

@@ -36,7 +36,7 @@ 
 	protected $repoClass = 'ForeignApiRepo';
 
 	/**
-	 * @param Title|string|bool $title
+	 * @param Title|null $title
 	 * @param ForeignApiRepo $repo
 	 * @param array $info
 	 * @param bool $exists
@@ -169,7 +169,7 @@ 
 	}
 
 	/**
-	 * @return bool|null|string
+	 * @return string|null
 	 */
 	public function getMetadata() {
 		if ( isset( $this->mInfo['metadata'] ) ) {
@@ -208,7 +208,7 @@ 
 	}
 
 	/**
-	 * @return bool|int|null
+	 * @return integer|null
 	 */
 	public function getSize() {
 		return isset( $this->mInfo['size'] ) ? intval( $this->mInfo['size'] ) : null;
@@ -271,7 +271,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return false|string
 	 */
 	function getTimestamp() {
 		return wfTimestamp( TS_MW,

includes/GlobalFunctions.php

Doc Comments +14 added lines, -20 removed lines

@@ -234,7 +234,6 @@ 
  *   		[ 'y' ]
  *   	]
  *
- * @param array $array1,...
  * @return array
  */
 function wfMergeErrorArrays( /*...*/ ) {
@@ -261,8 +260,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.
@@ -1301,7 +1300,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() {
@@ -1376,7 +1375,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
@@ -1397,7 +1395,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
@@ -1628,7 +1625,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;
@@ -1716,7 +1713,7 @@ 
  * @param mixed $dest
  * @param mixed $source
  * @param bool $force
- * @return mixed
+ * @return string
  */
 function wfSetVar( &$dest, $source, $force = false ) {
 	$temp = $dest;
@@ -1766,7 +1763,7 @@ 
 /**
  * Provide a simple HTTP error.
  *
- * @param int|string $code
+ * @param integer $code
  * @param string $label
  * @param string $desc
  */
@@ -1999,8 +1996,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 );
@@ -2039,7 +2036,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;
@@ -2268,7 +2265,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() {
@@ -2882,7 +2879,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'
@@ -2967,7 +2964,6 @@ 
 /**
  * Make a cache key for the local wiki.
  *
- * @param string $args,...
  * @return string
  */
 function wfMemcKey( /*...*/ ) {
@@ -2984,7 +2980,6 @@ 
  *
  * @param string $db
  * @param string $prefix
- * @param string $args,...
  * @return string
  */
 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
@@ -3004,7 +2999,6 @@ 
  * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
  *
  * @since 1.26
- * @param string $args,...
  * @return string
  */
 function wfGlobalCacheKey( /*...*/ ) {
@@ -3119,7 +3113,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 );
@@ -3324,7 +3318,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() {
@@ -3460,7 +3454,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/filebackend/FSFile.php

Doc Comments +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
 	/**
 	 * Get the file's last-modified timestamp
 	 *
-	 * @return string|bool TS_MW timestamp or false on failure
+	 * @return false|string TS_MW timestamp or false on failure
 	 */
 	public function getTimestamp() {
 		MediaWiki\suppressWarnings();
@@ -181,7 +181,7 @@ 
 	 * fairly neatly.
 	 *
 	 * @param bool $recache
-	 * @return bool|string False on failure
+	 * @return string|false False on failure
 	 */
 	public function getSha1Base36( $recache = false ) {
 		if ( $this->sha1Base36 !== null && !$recache ) {
@@ -233,7 +233,7 @@ 
 	 * fairly neatly.
 	 *
 	 * @param string $path
-	 * @return bool|string False on failure
+	 * @return string|false False on failure
 	 */
 	public static function getSha1Base36FromPath( $path ) {
 		$fsFile = new self( $path );

includes/libs/filebackend/TempFSFile.php

Doc Comments +3 added lines

@@ -34,6 +34,9 @@
 	/** @var array Map of (path => 1) for paths to delete on shutdown */
 	protected static $pathsCollect = null;
 
+	/**
+	 * @param false|string $path
+	 */
 	public function __construct( $path ) {
 		parent::__construct( $path );
 

includes/libs/IP.php

Doc Comments +3 added lines, -3 removed lines

@@ -299,7 +299,7 @@ 
 	 *
 	 * @param string $host
 	 * @param int $port
-	 * @param bool|int $defaultPort
+	 * @param integer $defaultPort
 	 * @return string
 	 */
 	public static function combineHostAndPort( $host, $port, $defaultPort = false ) {
@@ -402,7 +402,7 @@ 
 	 * hexadecimal string which sorts after the IPv4 addresses.
 	 *
 	 * @param string $ip Quad dotted/octet IP address.
-	 * @return string|bool False on failure
+	 * @return string|false False on failure
 	 */
 	public static function toHex( $ip ) {
 		if ( self::isIPv6( $ip ) ) {
@@ -435,7 +435,7 @@ 
 	 * Given an IPv6 address in octet notation, returns a pure hex string.
 	 *
 	 * @param string $ip Octet ipv6 IP address.
-	 * @return string|bool Pure hex (uppercase); false on failure
+	 * @return false|string Pure hex (uppercase); false on failure
 	 */
 	private static function IPv6ToRawHex( $ip ) {
 		$ip = self::sanitizeIP( $ip );

includes/libs/rdbms/database/DatabaseSqlite.php

Doc Comments +2 added lines, -2 removed lines

@@ -554,7 +554,7 @@ 
 	 * Filter the options used in SELECT statements
 	 *
 	 * @param array $options
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		foreach ( $options as $k => $v ) {
@@ -784,7 +784,7 @@ 
 
 	/**
 	 * @param string|int|null|bool|Blob $s
-	 * @return string|int
+	 * @return string
 	 */
 	function addQuotes( $s ) {
 		if ( $s instanceof Blob ) {

includes/libs/stats/SamplingStatsdClient.php

Doc Comments +1 added lines

@@ -35,6 +35,7 @@
 	 * The sample rate specified in a StatsdData entity overrides the sample rate specified here.
 	 *
 	 * {@inheritDoc}
+	 * @return StatsdDataInterface[]
 	 */
 	public function appendSampleRate( $data, $sampleRate = 1 ) {
 		if ( $sampleRate < 1 ) {

includes/parser/ParserOutput.php

Doc Comments +42 added lines, -1 removed lines

@@ -417,6 +417,9 @@ 
 		return $this->mEnableOOUI;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	public function setText( $text ) {
 		return wfSetVar( $this->mText, $text );
 	}
@@ -437,32 +440,52 @@ 
 		return wfSetVar( $this->mSections, $toc );
 	}
 
+	/**
+	 * @param boolean $t
+	 */
 	public function setEditSectionTokens( $t ) {
 		return wfSetVar( $this->mEditSectionTokens, $t );
 	}
 
+	/**
+	 * @param string $policy
+	 */
 	public function setIndexPolicy( $policy ) {
 		return wfSetVar( $this->mIndexPolicy, $policy );
 	}
 
+	/**
+	 * @param string $tochtml
+	 */
 	public function setTOCHTML( $tochtml ) {
 		return wfSetVar( $this->mTOCHTML, $tochtml );
 	}
 
+	/**
+	 * @param false|string $timestamp
+	 */
 	public function setTimestamp( $timestamp ) {
 		return wfSetVar( $this->mTimestamp, $timestamp );
 	}
 
+	/**
+	 * @param boolean $flag
+	 */
 	public function setTOCEnabled( $flag ) {
 		return wfSetVar( $this->mTOCEnabled, $flag );
 	}
 
+	/**
+	 * @param string $c
+	 */
 	public function addCategory( $c, $sort ) {
 		$this->mCategories[$c] = $sort;
 	}
 
 	/**
 	 * @since 1.25
+	 * @param string $id
+	 * @param string $content
 	 */
 	public function setIndicator( $id, $content ) {
 		$this->mIndicators[$id] = $content;
@@ -479,10 +502,16 @@ 
 		$this->mEnableOOUI = $enable;
 	}
 
+	/**
+	 * @param string $t
+	 */
 	public function addLanguageLink( $t ) {
 		$this->mLanguageLinks[] = $t;
 	}
 
+	/**
+	 * @param string $s
+	 */
 	public function addWarning( $s ) {
 		$this->mWarnings[$s] = 1;
 	}
@@ -491,9 +520,16 @@ 
 		$this->mOutputHooks[] = [ $hook, $data ];
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function setNewSection( $value ) {
 		$this->mNewSection = (bool)$value;
 	}
+
+	/**
+	 * @param boolean $value
+	 */
 	public function hideNewSection( $value ) {
 		$this->mHideNewSection = (bool)$value;
 	}
@@ -822,6 +858,8 @@ 
 	 *    $parser->getOutput()->my_ext_foo = '...';
 	 * @endcode
 	 *
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function setProperty( $name, $value ) {
 		$this->mProperties[$name] = $value;
@@ -830,7 +868,7 @@ 
 	/**
 	 * @param string $name The property name to look up.
 	 *
-	 * @return mixed|bool The value previously set using setProperty(). False if null or no value
+	 * @return string The value previously set using setProperty(). False if null or no value
 	 * was set for the given property name.
 	 *
 	 * @note You need to use getProperties() to check for boolean and null properties.
@@ -945,6 +983,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $clock
+	 */
 	private static function getTimes( $clock = null ) {
 		$ret = [];
 		if ( !$clock || $clock === 'wall' ) {

includes/RevisionList.php

Doc Comments +2 added lines, -2 removed lines

@@ -57,7 +57,7 @@ 
 	/**
 	 * Get the internal type name of this list. Equal to the table name.
 	 * Override this function.
-	 * @return null
+	 * @return string
 	 */
 	public function getType() {
 		return null;
@@ -228,7 +228,7 @@ 
 
 	/**
 	 * Get the timestamp in MW 14-char form
-	 * @return mixed
+	 * @return false|string
 	 */
 	public function getTimestamp() {
 		$field = $this->getTimestampField();