wikimedia / mediawiki

includes/OutputPage.php

Doc Comments +15 added lines, -9 removed lines

@@ -652,7 +652,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 );
@@ -969,7 +969,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();
@@ -1587,7 +1587,7 @@ 
 	/**
 	 * Set the displayed file version
 	 *
-	 * @param File|bool $file
+	 * @param File $file
 	 * @return mixed Previous value
 	 */
 	public function setFileVersion( $file ) {
@@ -1936,7 +1936,7 @@ 
 	/**
 	 * Get the list of cookies that will influence on the cache
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheVaryCookies() {
 		static $cookies;
@@ -2315,7 +2315,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
@@ -2341,8 +2341,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 = [] ) {
@@ -2538,6 +2538,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function showFatalError( $message ) {
 		$this->prepareErrorPage( $this->msg( 'internalerror' ) );
 
@@ -2556,6 +2559,9 @@ 
 		$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function showFileDeleteError( $name ) {
 		$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
 	}
@@ -2582,7 +2588,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
 	 */
@@ -3843,7 +3849,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/htmlform/HTMLFormField.php

Doc Comments +9 added lines, -2 removed lines

@@ -318,6 +318,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param HTMLFormField[] $alldata
+	 */
 	function filter( $value, $alldata ) {
 		if ( isset( $this->mFilterCallback ) ) {
 			$value = call_user_func( $this->mFilterCallback, $value, $alldata, $this->mParent );
@@ -645,6 +648,7 @@ 
 
 	/**
 	 * Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.
+	 * @param OOUI\Widget $inputField
 	 * @return OOUI\FieldLayout|OOUI\ActionFieldLayout
 	 */
 	protected function getFieldLayoutOOUI( $inputField, $config ) {
@@ -818,7 +822,7 @@ 
 	 * @since 1.20
 	 *
 	 * @param string $value The value of the input
-	 * @return array array( $errors, $errorClass )
+	 * @return string[] array( $errors, $errorClass )
 	 */
 	public function getErrorsAndErrorClass( $value ) {
 		$errors = $this->validate( $value, $this->mParent->mFieldData );
@@ -930,6 +934,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @return callable
+	 */
 	function getDefault() {
 		if ( isset( $this->mDefault ) ) {
 			return $this->mDefault;
@@ -1103,7 +1110,7 @@ 
 	/**
 	 * Formats one or more errors as accepted by field validation-callback.
 	 *
-	 * @param string|Message|array $errors Array of strings or Message instances
+	 * @param string $errors Array of strings or Message instances
 	 * @return string HTML
 	 * @since 1.18
 	 */

includes/tidy/Balancer.php

Doc Comments +18 added lines, -3 removed lines

@@ -800,7 +800,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
 	 */
@@ -890,6 +890,7 @@ 
 
 	/**
 	 * Return the adjusted current node.
+	 * @param BalanceElement|null $fragmentContext
 	 */
 	public function adjustedCurrentNode( $fragmentContext ) {
 		return ( $fragmentContext && count( $this->elements ) === 1 ) ?
@@ -899,7 +900,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 );
@@ -1133,7 +1134,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
 	 */
@@ -1499,6 +1500,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;
@@ -1646,6 +1648,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,
@@ -2214,6 +2220,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 );
@@ -3299,6 +3309,11 @@ 
 			return false;
 		}
 	}
+
+	/**
+	 * @param string $token
+	 * @param string $value
+	 */
 	private function inCellMode( $token, $value, $attribs = null, $selfClose = false ) {
 		if ( $token === 'tag' ) {
 			switch ( $value ) {

includes/specials/SpecialContributions.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
 	/**
 	 * Generates the subheading with links
 	 * @param User $userObj User object for the target
-	 * @return string Appropriately-escaped HTML to be output literally
+	 * @return Message Appropriately-escaped HTML to be output literally
 	 * @todo FIXME: Almost the same as contributionsSub in SpecialContributions.php. Could be combined.
 	 */
 	function getSubTitle( $userObj ) {

includes/specials/SpecialProtectedpages.php

Doc Comments +4 added lines, -4 removed lines

@@ -181,7 +181,7 @@ 
 
 	/**
 	 * @param string $sizetype "min" or "max"
-	 * @param mixed $size
+	 * @param integer $size
 	 * @return string Formatted HTML
 	 */
 	protected function getSizeLimit( $sizetype, $size ) {
@@ -290,9 +290,9 @@ 
 	/**
 	 * @param SpecialProtectedpages $form
 	 * @param array $conds
-	 * @param $type
-	 * @param $level
-	 * @param $namespace
+	 * @param null|string $type
+	 * @param null|string $level
+	 * @param integer|null $namespace
 	 * @param string $sizetype
 	 * @param int $size
 	 * @param bool $indefonly

includes/skins/BaseTemplate.php

Doc Comments +6 added lines

@@ -35,6 +35,9 @@ 
 		return $this->getSkin()->msg( $name );
 	}
 
+	/**
+	 * @param string $str
+	 */
 	function msg( $str ) {
 		echo $this->getMsg( $str )->escaped();
 	}
@@ -506,6 +509,9 @@ 
 		return Html::element( 'input', $realAttrs );
 	}
 
+	/**
+	 * @param string $mode
+	 */
 	function makeSearchButton( $mode, $attrs = [] ) {
 		switch ( $mode ) {
 			case 'go':

includes/user/User.php

Doc Comments +7 added lines, -7 removed lines

@@ -1181,7 +1181,7 @@ 
 	/**
 	 * Load user data from the session.
 	 *
-	 * @return bool True if the user is logged in, false otherwise.
+	 * @return null|boolean True if the user is logged in, false otherwise.
 	 */
 	private function loadFromSession() {
 		// Deprecated hook
@@ -2855,7 +2855,7 @@ 
 	 * resetting it if it's empty (and saving changes).
 	 *
 	 * @param string $oname The option name to retrieve the token from
-	 * @return string|bool User's current value for the option, or false if this option is disabled.
+	 * @return false|string User's current value for the option, or false if this option is disabled.
 	 * @see resetTokenFromOption()
 	 * @see getOption()
 	 * @deprecated since 1.26 Applications should use the OAuth extension
@@ -2884,7 +2884,7 @@ 
 	 * *Does not* save user's preferences (similarly to setOption()).
 	 *
 	 * @param string $oname The option name to reset the token in
-	 * @return string|bool New token value, or false if this option is disabled.
+	 * @return false|string New token value, or false if this option is disabled.
 	 * @see getTokenFromOption()
 	 * @see setOption()
 	 */
@@ -2920,7 +2920,7 @@ 
 	 * new option kind is added.
 	 *
 	 * @see User::getOptionKinds
-	 * @return array Option kinds
+	 * @return string[] Option kinds
 	 */
 	public static function listOptionKinds() {
 		return [
@@ -4474,7 +4474,7 @@ 
 	/**
 	 * Get the timestamp of account creation.
 	 *
-	 * @return string|bool|null Timestamp of account creation, false for
+	 * @return false|string Timestamp of account creation, false for
 	 *  non-existent/anonymous user accounts, or null if existing account
 	 *  but information is not in database.
 	 */
@@ -4489,7 +4489,7 @@ 
 	/**
 	 * Get the timestamp of the first edit
 	 *
-	 * @return string|bool Timestamp of first edit, or false for
+	 * @return false|string Timestamp of first edit, or false for
 	 *  non-existent/anonymous user accounts.
 	 */
 	public function getFirstEditTimestamp() {
@@ -5259,7 +5259,7 @@ 
 	/**
 	 * Return the list of user fields that should be selected to create
 	 * a new user object.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		return [

includes/api/ApiUpload.php

Doc Comments +1 added lines, -1 removed lines

@@ -663,7 +663,7 @@
 	 * Handles a stash exception, giving a useful error to the user.
 	 * @param string $exceptionType Class name of the exception we encountered.
 	 * @param string $message Message of the exception we encountered.
-	 * @return array Array of message and code, suitable for passing to dieUsage()
+	 * @return string[] Array of message and code, suitable for passing to dieUsage()
 	 */
 	protected function handleStashException( $exceptionType, $message ) {
 		switch ( $exceptionType ) {

includes/media/DjVuImage.php

Doc Comments +13 added lines

@@ -92,6 +92,10 @@ 
 		fclose( $file );
 	}
 
+	/**
+	 * @param resource $file
+	 * @param integer $indent
+	 */
 	private function dumpForm( $file, $length, $indent ) {
 		$start = ftell( $file );
 		$secondary = fread( $file, 4 );
@@ -165,6 +169,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $chunkLength
+	 */
 	private function skipChunk( $file, $chunkLength ) {
 		fseek( $file, $chunkLength, SEEK_CUR );
 
@@ -174,6 +181,9 @@ 
 		}
 	}
 
+	/**
+	 * @param resource $file
+	 */
 	private function getMultiPageInfo( $file, $formLength ) {
 		// For now, we'll just look for the first page in the file
 		// and report its information, hoping others are the same size.
@@ -368,6 +378,9 @@ 
 		return $xml;
 	}
 
+	/**
+	 * @param string $line
+	 */
 	function parseFormDjvu( $line, &$xml ) {
 		$parentLevel = strspn( $line, ' ' );
 		$line = strtok( "\n" );