wikimedia / mediawiki

includes/libs/rdbms/database/DatabasePostgres.php

Doc Comments +12 added lines, -1 removed lines

@@ -59,6 +59,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function hasConstraint( $name ) {
 		$sql = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n " .
 			"WHERE c.connamespace = n.oid AND conname = '" .
@@ -1109,6 +1112,10 @@ 
 		return $this->relationExists( $sequence, 'S', $schema );
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $trigger
+	 */
 	function triggerExists( $table, $trigger ) {
 		$q = <<<SQL
 	SELECT 1 FROM pg_class, pg_namespace, pg_trigger
@@ -1132,6 +1139,10 @@ 
 		return $rows;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $rule
+	 */
 	function ruleExists( $table, $rule ) {
 		$exists = $this->selectField( 'pg_rules', 'rulename',
 			[
@@ -1279,7 +1290,7 @@ 
 	 *
 	 * @param array $options An associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		$preLimitTail = $postLimitTail = '';

maintenance/sql.php

Doc Comments +3 added lines

@@ -143,6 +143,9 @@
 		wfWaitForSlaves();
 	}
 
+	/**
+	 * @param boolean $dieOnError
+	 */
 	protected function sqlDoQuery( IDatabase $db, $line, $dieOnError ) {
 		try {
 			$res = $db->query( $line );

includes/api/ApiBase.php

Doc Comments +9 added lines, -5 removed lines

@@ -421,7 +421,7 @@ 
 	 *
 	 * @since 1.24
 	 * @param array $params All supplied parameters for the module
-	 * @return string|array|null
+	 * @return string
 	 */
 	protected function getWebUITokenSalt( array $params ) {
 		return null;
@@ -627,6 +627,7 @@ 
 	/**
 	 * Set the continuation manager
 	 * @param ApiContinuationManager|null
+	 * @param ApiContinuationManager|null $manager
 	 */
 	public function setContinuationManager( $manager ) {
 		// Main module has setContinuationManager() method overridden
@@ -710,6 +711,7 @@ 
 	 *
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which exactly one must be set
+	 * @param string $required
 	 */
 	public function requireOnlyOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -736,6 +738,7 @@ 
 	 *
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which at most one must be set
+	 * @param string $required
 	 */
 	public function requireMaxOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -759,6 +762,7 @@ 
 	 * @since 1.23
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which at least one must be set
+	 * @param string $required
 	 */
 	public function requireAtLeastOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -1431,7 +1435,7 @@ 
 
 	/**
 	 * Truncate an array to a certain length.
-	 * @param array $arr Array to truncate
+	 * @param string[] $arr Array to truncate
 	 * @param int $limit Maximum length
 	 * @return bool True if the array was truncated, false otherwise
 	 */
@@ -2638,7 +2642,7 @@ 
 	 * "apihelp-{$this->getModulePath()}-description".
 	 *
 	 * @deprecated since 1.25
-	 * @return Message|string|array
+	 * @return boolean
 	 */
 	protected function getDescription() {
 		return false;
@@ -2715,7 +2719,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileTime() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2738,7 +2742,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileDBTime() {
 		wfDeprecated( __METHOD__, '1.25' );

includes/libs/filebackend/FileBackend.php

Doc Comments +1 added lines, -1 removed lines

@@ -192,7 +192,7 @@
 	/**
 	 * Get an explanatory message if this backend is read-only
 	 *
-	 * @return string|bool Returns false if the backend is not read-only
+	 * @return string|false Returns false if the backend is not read-only
 	 */
 	final public function getReadOnlyReason() {
 		return ( $this->readOnly != '' ) ? $this->readOnly : false;

includes/libs/xmp/XMP.php

Doc Comments +1 added lines, -1 removed lines

@@ -491,7 +491,7 @@
 	 * <exif:DigitalZoomRatio>0/10</exif:DigitalZoomRatio>
 	 * and are processing the 0/10 bit.
 	 *
-	 * @param XMLParser $parser XMLParser reference to the xml parser
+	 * @param resource $parser XMLParser reference to the xml parser
 	 * @param string $data Character data
 	 * @throws RuntimeException On invalid data
 	 */

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/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/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 ) {