wikimedia / mediawiki

includes/specialpage/LoginSignupSpecialPage.php

Doc Comments +4 added lines, -2 removed lines

@@ -81,6 +81,9 @@ 
 	 */
 	abstract protected function logAuthResult( $success, $status = null );
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct( $name ) {
 		global $wgUseMediaWikiUIEverywhere;
 		parent::__construct( $name );
@@ -365,7 +368,7 @@ 
 	 * Show the success page.
 	 *
 	 * @param string $type Condition of return to; see `executeReturnTo`
-	 * @param string|Message $title Page's title
+	 * @param Message $title Page's title
 	 * @param string $msgname
 	 * @param string $injected_html
 	 * @param StatusValue|null $extraMessages
@@ -414,7 +417,6 @@ 
 	/**
 	 * Replace some globals to make sure the fact that the user has just been logged in is
 	 * reflected in the current request.
-	 * @param User $user
 	 */
 	protected function setSessionUserForCurrentRequest() {
 		global $wgUser, $wgLang;

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/db/Database.php

Doc Comments +9 added lines, -5 removed lines

@@ -653,7 +653,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -925,6 +925,10 @@ 
 		return $res;
 	}
 
+	/**
+	 * @param string $sql
+	 * @param boolean $priorWritesPending
+	 */
 	private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
 		# Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
 		# Dropped connections also mean that named locks are automatically released.
@@ -1145,7 +1149,7 @@ 
 	 *
 	 * @param array $options Associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 * @see DatabaseBase::select()
 	 */
 	public function makeSelectOptions( $options ) {
@@ -3060,8 +3064,8 @@ 
 	 * on object's error ignore settings).
 	 *
 	 * @param string $filename File name to open
-	 * @param bool|callable $lineCallback Optional function called before reading each line
-	 * @param bool|callable $resultCallback Optional function called for each MySQL result
+	 * @param boolean $lineCallback Optional function called before reading each line
+	 * @param boolean $resultCallback Optional function called for each MySQL result
 	 * @param bool|string $fname Calling function name or false if name should be
 	 *   generated dynamically using $filename
 	 * @param bool|callable $inputCallback Optional function called for each
@@ -3392,7 +3396,7 @@ 
 	}
 
 	/**
-	 * @return string|bool Reason this DB is read-only or false if it is not
+	 * @return string|false Reason this DB is read-only or false if it is not
 	 */
 	protected function getReadOnlyReason() {
 		$reason = $this->getLBInfo( 'readOnlyReason' );

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" );

includes/resourceloader/ResourceLoaderClientHtml.php

Doc Comments -1 removed lines

@@ -104,7 +104,6 @@
 	 *
 	 * See OutputPage::buildExemptModules() for use cases.
 	 *
-	 * @param array $modules Module state keyed by module name
 	 */
 	public function setExemptStates( array $states ) {
 		$this->exemptStates = $states;