wikimedia / mediawiki

includes/changes/ChangesList.php

Doc Comments +9 added lines, -3 removed lines

@@ -153,7 +153,7 @@ 
 	 * @param RecentChange|RCCacheEntry $rc
 	 * @param string|bool $watched Optionally timestamp for adding watched class
 	 *
-	 * @return array of classes
+	 * @return string[] of classes
 	 */
 	protected function getHTMLClasses( $rc, $watched ) {
 		$classes = [];
@@ -228,7 +228,7 @@ 
 	}
 
 	/**
-	 * @param ResultWrapper|array $rows
+	 * @param ResultWrapper $rows
 	 */
 	public function initChangesListRows( $rows ) {
 		Hooks::run( 'ChangesListInitRows', [ $this, $rows ] );
@@ -478,6 +478,8 @@ 
 	 *
 	 * @param string &$s HTML to update
 	 * @param RecentChange &$rc
+	 * @param string $s
+	 * @param RecentChange $rc
 	 */
 	public function insertUserRelatedLinks( &$s, &$rc ) {
 		if ( $this->isDeleted( $rc, Revision::DELETED_USER ) ) {
@@ -636,7 +638,7 @@ 
 
 	/**
 	 * @param RecentChange $rc
-	 * @param array $classes
+	 * @param string[] $classes
 	 * @return string
 	 * @since 1.26
 	 */
@@ -646,6 +648,10 @@ 
 		return $s;
 	}
 
+	/**
+	 * @param string $s
+	 * @param RecentChange $rc
+	 */
 	public function insertExtra( &$s, &$rc, &$classes ) {
 		// Empty, used for subclasses to add anything special.
 	}

includes/gallery/SlideshowImageGallery.php

Doc Comments +1 added lines, -1 removed lines

@@ -85,7 +85,7 @@
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	function getOrderFields() {
 		return array( 'rd_namespace', 'rd_title', 'rd_from' );

includes/Sanitizer.php

Doc Comments +4 added lines, -4 removed lines

@@ -1206,7 +1206,7 @@ 
 	 * @since 1.27
 	 *
 	 * @param string $referenceString Space delimited list of ids
-	 * @param string|array $options String or array of strings (default is array()):
+	 * @param string $options String or array of strings (default is array()):
 	 *   'noninitial': This is a non-initial fragment of an id, not a full id,
 	 *       so don't pay attention if the first character isn't valid at the
 	 *       beginning of an id.  Only matters if $wgExperimentalHtmlIds is
@@ -1334,7 +1334,7 @@ 
 	 * Pick the appropriate attribute value from a match set from the
 	 * attribs regex matches.
 	 *
-	 * @param array $set
+	 * @param string[] $set
 	 * @throws MWException When tag conditions are not met.
 	 * @return string
 	 */
@@ -1850,7 +1850,7 @@ 
 
 	/**
 	 * @param string $url
-	 * @return mixed|string
+	 * @return string
 	 */
 	static function cleanUrl( $url ) {
 		# Normalize any HTML entities in input. They will be
@@ -1936,7 +1936,7 @@ 
 	 * @since 1.18
 	 *
 	 * @param string $addr E-mail address
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public static function validateEmail( $addr ) {
 		$result = null;

includes/tidy/Balancer.php

Doc Comments +18 added lines, -3 removed lines

@@ -751,7 +751,7 @@ 
 
 	/**
 	 * Determine if the stack has $tag in button scope.
-	 * @param BalanceElement|array|string $tag
+	 * @param string $tag
 	 * @return bool
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#has-an-element-in-button-scope
 	 */
@@ -831,6 +831,7 @@ 
 
 	/**
 	 * Return the adjusted current node.
+	 * @param BalanceElement|null $fragmentContext
 	 */
 	public function adjustedCurrentNode( $fragmentContext ) {
 		return ( $fragmentContext && $this->length() === 1 ) ?
@@ -840,7 +841,7 @@ 
 	/**
 	 * Return an iterator over this stack which visits the current node
 	 * first, and the root node last.
-	 * @return Iterator
+	 * @return ReverseArrayIterator
 	 */
 	public function getIterator() {
 		return new ReverseArrayIterator( $this->elements );
@@ -1063,7 +1064,7 @@ 
 	 * @param string $tag The subject tag name.
 	 * @param BalanceActiveFormattingElements $afe The current
 	 *   active formatting elements list.
-	 * @return true if the adoption agency algorithm "did something", false
+	 * @return boolean if the adoption agency algorithm "did something", false
 	 *   if more processing is required by the caller.
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#adoption-agency-algorithm
 	 */
@@ -1441,6 +1442,7 @@ 
 	 * Find and return the last element with the specified tag between the
 	 * end of the list and the last marker on the list.
 	 * Used when parsing <a> "in body mode".
+	 * @param string $tag
 	 */
 	public function findElementByTag( $tag ) {
 		$elt = $this->tail;
@@ -1588,6 +1590,10 @@ 
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#reconstruct-the-active-formatting-elements
 	 */
 	// @codingStandardsIgnoreEnd
+
+	/**
+	 * @param BalanceStack|null $stack
+	 */
 	public function reconstruct( $stack ) {
 		$entry = $this->tail;
 		// If there are no entries in the list of active formatting elements,
@@ -2051,6 +2057,10 @@ 
 		return $oldMode;
 	}
 
+	/**
+	 * @param string $mode
+	 * @param boolean $selfclose
+	 */
 	private function switchModeAndReprocess( $mode, $token, $value, $attribs, $selfclose ) {
 		$this->switchMode( $mode );
 		return $this->insertToken( $token, $value, $attribs, $selfclose );
@@ -3080,6 +3090,11 @@ 
 			return false;
 		}
 	}
+
+	/**
+	 * @param string $token
+	 * @param string $value
+	 */
 	private function inCellMode( $token, $value, $attribs = null, $selfclose = false ) {
 		if ( $token === 'tag' ) {
 			switch ( $value ) {

includes/GlobalFunctions.php

Doc Comments +12 added lines, -18 removed lines

@@ -234,7 +234,6 @@ 
  *   		array( 'y' )
  *   	)
  *
- * @param array $array1,...
  * @return array
  */
 function wfMergeErrorArrays( /*...*/ ) {
@@ -261,7 +260,7 @@ 
  *
  * @param array $array The array.
  * @param array $insert The array to insert.
- * @param mixed $after The key to insert after
+ * @param string $after The key to insert after
  * @return array
  */
 function wfArrayInsertAfter( array $array, array $insert, $after ) {
@@ -1300,7 +1299,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() {
@@ -1375,7 +1374,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
@@ -1396,7 +1394,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
@@ -1627,7 +1624,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;
@@ -1763,7 +1760,7 @@ 
 /**
  * Provide a simple HTTP error.
  *
- * @param int|string $code
+ * @param integer $code
  * @param string $label
  * @param string $desc
  */
@@ -2045,8 +2042,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 {
@@ -2087,7 +2084,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;
@@ -2344,7 +2341,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() {
@@ -2958,7 +2955,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'
@@ -3043,7 +3040,6 @@ 
 /**
  * Make a cache key for the local wiki.
  *
- * @param string $args,...
  * @return string
  */
 function wfMemcKey( /*...*/ ) {
@@ -3060,7 +3056,6 @@ 
  *
  * @param string $db
  * @param string $prefix
- * @param string $args,...
  * @return string
  */
 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
@@ -3080,7 +3075,6 @@ 
  * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
  *
  * @since 1.26
- * @param string $args,...
  * @return string
  */
 function wfGlobalCacheKey( /*...*/ ) {
@@ -3195,7 +3189,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 );
@@ -3399,7 +3393,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() {
@@ -3535,7 +3529,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/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();
@@ -2543,7 +2547,7 @@ 
 	 * "apihelp-{$this->getModulePath()}-description".
 	 *
 	 * @deprecated since 1.25
-	 * @return Message|string|array
+	 * @return boolean
 	 */
 	protected function getDescription() {
 		return false;
@@ -2698,7 +2702,7 @@ 
 	 * Generates the parameter descriptions for this module, to be displayed in the
 	 * module's help.
 	 * @deprecated since 1.25
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function makeHelpMsgParameters() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2889,7 +2893,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileTime() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2912,7 +2916,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileDBTime() {
 		wfDeprecated( __METHOD__, '1.25' );

includes/Block.php

Doc Comments +3 added lines, -3 removed lines

@@ -185,7 +185,7 @@ 
 	/**
 	 * Return the list of ipblocks fields that should be selected to create
 	 * a new block.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		return [
@@ -1004,7 +1004,7 @@ 
 	/**
 	 * Get a timestamp of the expiry for autoblocks
 	 *
-	 * @param string|int $timestamp
+	 * @param string|false $timestamp
 	 * @return string
 	 */
 	public static function getAutoblockExpiry( $timestamp ) {
@@ -1361,7 +1361,7 @@ 
 	/**
 	 * @since 1.19
 	 *
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function getExpiry() {
 		return $this->mExpiry;

includes/Category.php

Doc Comments +7 added lines, -7 removed lines

@@ -205,42 +205,42 @@ 
 	}
 
 	/**
-	 * @return mixed DB key name, or false on failure
+	 * @return boolean DB key name, or false on failure
 	 */
 	public function getName() {
 		return $this->getX( 'mName' );
 	}
 
 	/**
-	 * @return mixed Category ID, or false on failure
+	 * @return boolean Category ID, or false on failure
 	 */
 	public function getID() {
 		return $this->getX( 'mID' );
 	}
 
 	/**
-	 * @return mixed Total number of member pages, or false on failure
+	 * @return boolean Total number of member pages, or false on failure
 	 */
 	public function getPageCount() {
 		return $this->getX( 'mPages' );
 	}
 
 	/**
-	 * @return mixed Number of subcategories, or false on failure
+	 * @return boolean Number of subcategories, or false on failure
 	 */
 	public function getSubcatCount() {
 		return $this->getX( 'mSubcats' );
 	}
 
 	/**
-	 * @return mixed Number of member files, or false on failure
+	 * @return boolean Number of member files, or false on failure
 	 */
 	public function getFileCount() {
 		return $this->getX( 'mFiles' );
 	}
 
 	/**
-	 * @return Title|bool Title for this category, or false on failure.
+	 * @return Title Title for this category, or false on failure.
 	 */
 	public function getTitle() {
 		if ( $this->mTitle ) {
@@ -260,7 +260,7 @@ 
 	 * category sort key $offset.
 	 * @param int $limit
 	 * @param string $offset
-	 * @return TitleArray TitleArray object for category members.
+	 * @return TitleArrayFromResult|null TitleArray object for category members.
 	 */
 	public function getMembers( $limit = false, $offset = '' ) {
 

includes/content/ContentHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -659,7 +659,7 @@ 
 	 *
 	 * @param IContextSource $context Context to use, anything else will be ignored.
 	 * @param int $old Revision ID we want to show and diff with.
-	 * @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
+	 * @param integer $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
 	 * @param int $rcid FIXME: Deprecated, no longer used. Defaults to 0.
 	 * @param bool $refreshCache If set, refreshes the diff cache. Defaults to false.
 	 * @param bool $unhide If set, allow viewing deleted revs. Defaults to false.
@@ -889,7 +889,7 @@ 
 	 * @param Title $title The page's title
 	 * @param bool &$hasHistory Whether the page has a history
 	 *
-	 * @return mixed String containing deletion reason or empty string, or
+	 * @return false|string String containing deletion reason or empty string, or
 	 *    boolean false if no revision occurred
 	 *
 	 * @todo &$hasHistory is extremely ugly, it's here because