wikimedia / mediawiki

includes/installer/Installer.php

Doc Comments +6 added lines, -6 removed lines

@@ -578,7 +578,7 @@ 
 	 * fake password in which case leave it as it is.
 	 *
 	 * @param string $name
-	 * @param mixed $value
+	 * @param string $value
 	 */
 	public function setPassword( $name, $value ) {
 		if ( !preg_match( '/^\*+$/', $value ) ) {
@@ -1266,7 +1266,7 @@ 
 	 *
 	 * If $versionInfo is not false, only executables with a version
 	 * matching $versionInfo[1] will be returned.
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function locateExecutable( $path, $names, $versionInfo = false ) {
 		if ( !is_array( $names ) ) {
@@ -1298,14 +1298,14 @@ 
 	/**
 	 * Same as locateExecutable(), but checks in getPossibleBinPaths() by default
 	 * @see locateExecutable()
-	 * @param array $names Array of possible names.
-	 * @param array|bool $versionInfo Default: false or array with two members:
+	 * @param string[] $names Array of possible names.
+	 * @param string[] $versionInfo Default: false or array with two members:
 	 *   0 => Command to run for version check, with $1 for the full executable name
 	 *   1 => String to compare the output with
 	 *
 	 * If $versionInfo is not false, only executables with a version
 	 * matching $versionInfo[1] will be returned.
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function locateExecutableInDefaultPaths( $names, $versionInfo = false ) {
 		foreach ( self::getPossibleBinPaths() as $path ) {
@@ -1324,7 +1324,7 @@ 
 	 * Used only by environment checks.
 	 * @param string $dir
 	 * @param string $url
-	 * @return bool|int|string
+	 * @return string|false
 	 */
 	public function dirIsExecutable( $dir, $url ) {
 		$scriptTypes = array(

includes/db/Database.php

Doc Comments +5 added lines, -5 removed lines

@@ -651,7 +651,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -1103,7 +1103,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 ) {
@@ -2959,8 +2959,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
@@ -3291,7 +3291,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/diff/DifferenceEngine.php

Doc Comments +5 added lines, -5 removed lines

@@ -104,7 +104,7 @@ 
 	 * Constructor
 	 * @param IContextSource $context Context to use, anything else will be ignored
 	 * @param int $old Old ID we want to show and diff with.
-	 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
+	 * @param integer $new Either revision ID or 'prev' or 'next'. Default: 0.
 	 * @param int $rcid Deprecated, no longer used!
 	 * @param bool $refreshCache If set, refreshes the diff cache
 	 * @param bool $unhide If set, allow viewing deleted revs
@@ -174,7 +174,7 @@ 
 	 *
 	 * @param int $id Revision ID
 	 *
-	 * @return mixed URL or false
+	 * @return string|false URL or false
 	 */
 	public function deletedLink( $id ) {
 		if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
@@ -676,7 +676,7 @@ 
 	 * @param string|bool $ntitle Header for new text or false
 	 * @param string $notice HTML between diff header and body
 	 *
-	 * @return mixed
+	 * @return false|string
 	 */
 	public function getDiff( $otitle, $ntitle, $notice = '' ) {
 		$body = $this->getDiffBody();
@@ -698,7 +698,7 @@ 
 	/**
 	 * Get the diff table body, without header
 	 *
-	 * @return mixed (string/false)
+	 * @return false|string (string/false)
 	 */
 	public function getDiffBody() {
 		$this->mCacheHit = true;
@@ -973,7 +973,7 @@ 
 	 *
 	 * @param string $text
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function localiseLineNumbers( $text ) {
 		return preg_replace_callback(

includes/filerepo/file/LocalFile.php

Doc Comments +5 added lines, -5 removed lines

@@ -191,7 +191,7 @@ 
 
 	/**
 	 * Fields in the image table
-	 * @return array
+	 * @return string[]
 	 */
 	static function selectFields() {
 		return [
@@ -1114,11 +1114,11 @@ 
 
 	/**
 	 * Upload a file and record it in the DB
-	 * @param string|FSFile $src Source storage path, virtual URL, or filesystem path
+	 * @param string $src Source storage path, virtual URL, or filesystem path
 	 * @param string $comment Upload description
 	 * @param string $pageText Text to use for the new description page,
 	 *   if a new description page is created
-	 * @param int|bool $flags Flags for publish()
+	 * @param integer $flags Flags for publish()
 	 * @param array|bool $props File properties, if known. This can be used to
 	 *   reduce the upload time when uploading virtual URLs for which the file
 	 *   info is already known
@@ -1815,7 +1815,7 @@ 
 	 * it skips the parser cache.
 	 *
 	 * @param Language $lang What language to get description in (Optional)
-	 * @return bool|mixed
+	 * @return false|string
 	 */
 	function getDescriptionText( $lang = null ) {
 		$revision = Revision::newFromTitle( $this->title, false, Revision::READ_NORMAL );
@@ -1859,7 +1859,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public function getDescriptionTouched() {
 		// The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo

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 );
@@ -625,6 +628,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 ) {
@@ -798,7 +802,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 );
@@ -886,6 +890,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @return string
+	 */
 	function getDefault() {
 		if ( isset( $this->mDefault ) ) {
 			return $this->mDefault;
@@ -1059,7 +1066,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/import/WikiImporter.php

Doc Comments +3 added lines

@@ -116,6 +116,9 @@
 		wfDebug( "IMPORT: $data\n" );
 	}
 
+	/**
+	 * @param string $msg
+	 */
 	public function notice( $msg /*, $param, ...*/ ) {
 		$params = func_get_args();
 		array_shift( $params );

includes/media/MediaHandler.php

Doc Comments +3 added lines, -3 removed lines

@@ -196,7 +196,7 @@ 
 	 *
 	 * @note This method is currently unused.
 	 * @param File $image
-	 * @return string
+	 * @return boolean
 	 */
 	function getMetadataType( $image ) {
 		return false;
@@ -308,7 +308,7 @@ 
 	 * @param string $ext Extension of original file
 	 * @param string $mime MIME type of original file
 	 * @param array $params Handler specific rendering parameters
-	 * @return array Thumbnail extension and MIME type
+	 * @return string[] Thumbnail extension and MIME type
 	 */
 	function getThumbType( $ext, $mime, $params = null ) {
 		$magic = MimeMagic::singleton();
@@ -648,7 +648,7 @@ 
 	 * @param int $boxWidth Width of the thumbnail box.
 	 * @param int $boxHeight Height of the thumbnail box.
 	 * @param int $maxHeight Maximum height expected for the thumbnail.
-	 * @return int
+	 * @return double
 	 */
 	public static function fitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {
 		$idealWidth = $boxWidth * $maxHeight / $boxHeight;

includes/OutputPage.php

Doc Comments +14 added lines, -8 removed lines

@@ -979,7 +979,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();
@@ -1597,7 +1597,7 @@ 
 	/**
 	 * Set the displayed file version
 	 *
-	 * @param File|bool $file
+	 * @param File $file
 	 * @return mixed Previous value
 	 */
 	public function setFileVersion( $file ) {
@@ -1943,7 +1943,7 @@ 
 	/**
 	 * Get the list of cookies that will influence on the cache
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheVaryCookies() {
 		static $cookies;
@@ -2322,7 +2322,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
@@ -2348,8 +2348,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 = [] ) {
@@ -2545,6 +2545,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function showFatalError( $message ) {
 		$this->prepareErrorPage( $this->msg( 'internalerror' ) );
 
@@ -2563,6 +2566,9 @@ 
 		$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function showFileDeleteError( $name ) {
 		$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
 	}
@@ -2589,7 +2595,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
 	 */
@@ -3844,7 +3850,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/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;
@@ -1142,7 +1142,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 title already existed
+	 * @return integer The newly created page_id key; false if the title already existed
 	 */
 	public function insertOn( $dbw, $pageId = null ) {
 		$pageIdForInsert = $pageId ?: $dbw->nextSequenceValue( 'page_page_id_seq' );
@@ -1487,7 +1487,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
@@ -3360,7 +3360,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();
@@ -3435,7 +3435,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 ) {