wikimedia / mediawiki

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

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;

includes/WebRequest.php

Doc Comments +3 added lines, -3 removed lines

@@ -234,7 +234,7 @@ 
 	 * This is for use prior to Setup.php, when no WebRequest object is available.
 	 * At other times, use the non-static function getProtocol().
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function detectProtocol() {
 		if ( ( !empty( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] !== 'off' ) ||
@@ -604,7 +604,7 @@ 
 	/**
 	 * Returns the names of all input values excluding those in $exclude.
 	 *
-	 * @param array $exclude
+	 * @param string[] $exclude
 	 * @return array
 	 */
 	public function getValueNames( $exclude = [] ) {
@@ -743,7 +743,7 @@ 
 	 * @param string $key The name of the cookie
 	 * @param string $prefix A prefix to use for the cookie name, if not $wgCookiePrefix
 	 * @param mixed $default What to return if the value isn't found
-	 * @return mixed Cookie value or $default if the cookie not set
+	 * @return string Cookie value or $default if the cookie not set
 	 */
 	public function getCookie( $key, $prefix = null, $default = null ) {
 		if ( $prefix === null ) {

includes/page/WikiPage.php

Doc Comments +5 added lines, -5 removed lines

@@ -257,7 +257,7 @@ 
 	 * Return the list of revision fields that should be selected to create
 	 * a new page.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
@@ -1144,7 +1144,7 @@ 
 	 * @param IDatabase $dbw
 	 * @param int|null $pageId Custom page ID that will be used for the insert statement
 	 *
-	 * @return bool|int The newly created page_id key; false if the row was not
+	 * @return integer The newly created page_id key; false if the row was not
 	 *   inserted, e.g. because the title already existed or because the specified
 	 *   page ID is already in use.
 	 */
@@ -1491,7 +1491,7 @@ 
 	 * error will be returned. These two conditions are also possible with
 	 * auto-detection due to MediaWiki's performance-optimised locking strategy.
 	 *
-	 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
+	 * @param boolean $baseRevId The revision ID this edit was based off, if any.
 	 *   This is not the parent revision ID, rather the revision ID for older
 	 *   content used as the source for a rollback, for example.
 	 * @param User $user The user doing the edit
@@ -3370,7 +3370,7 @@ 
 	 * Returns a list of categories this page is a member of.
 	 * Results will include hidden categories
 	 *
-	 * @return TitleArray
+	 * @return TitleArrayFromResult|null
 	 */
 	public function getCategories() {
 		$id = $this->getId();
@@ -3445,7 +3445,7 @@ 
 	 * Auto-generates a deletion reason
 	 *
 	 * @param bool &$hasHistory Whether the page has a history
-	 * @return string|bool String containing deletion reason or empty string, or boolean false
+	 * @return false|string String containing deletion reason or empty string, or boolean false
 	 *    if no revision occurred
 	 */
 	public function getAutoDeleteReason( &$hasHistory ) {

maintenance/hhvm/makeRepo.php

Doc Comments +3 added lines

@@ -129,6 +129,9 @@
 		return 0;
 	}
 
+	/**
+	 * @param string $tmpDir
+	 */
 	private function cleanupTemp( $tmpDir ) {
 		if ( file_exists( "$tmpDir/hhvm.hhbc" ) ) {
 			unlink( "$tmpDir/hhvm.hhbc" );

includes/specialpage/LoginSignupSpecialPage.php

Doc Comments +5 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;
@@ -1254,6 +1256,7 @@ 
 
 	/**
 	 * @param array $formDescriptor
+	 * @param AuthenticationRequest[] $requests
 	 */
 	protected function postProcessFormDescriptor( &$formDescriptor, $requests ) {
 		// Pre-fill username (if not creating an account, T46775).

includes/content/TextContent.php

Doc Comments +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
 	 * changes.
 	 *
 	 * @since 1.28
-	 * @param $text
+	 * @param false|string $text
 	 * @return string
 	 */
 	public static function normalizeLineEndings( $text ) {