wikimedia / mediawiki

includes/libs/ReplacementArray.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/logging/LogFormatter.php

Doc Comments +1 added lines, -1 removed lines

@@ -423,7 +423,7 @@
 	 * Returns a sentence describing the log action. Usually
 	 * a Message object is returned, but old style log types
 	 * and entries might return pre-escaped HTML string.
-	 * @return Message|string Pre-escaped HTML
+	 * @return string Pre-escaped HTML
 	 */
 	protected function getActionMessage() {
 		$message = $this->msg( $this->getMessageKey() );

includes/media/DjVu.php

Doc Comments +3 added lines

@@ -371,6 +371,9 @@
 		return 'djvuxml';
 	}
 
+	/**
+	 * @param File $image
+	 */
 	function isMetadataValid( $image, $metadata ) {
 		return !empty( $metadata ) && $metadata != serialize( [] );
 	}

includes/media/MediaTransformOutput.php

Doc Comments +5 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
 	/**
 	 * Get the final extension of the thumbnail.
 	 * Returns false for scripted transformations.
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function getExtension() {
 		return $this->path ? FileBackend::extensionFromPath( $this->path ) : false;
@@ -214,7 +214,7 @@ 
 	 *
 	 * @deprecated since 1.26, use streamFileWithStatus
 	 * @param array $headers Additional HTTP headers to send on success
-	 * @return bool Success
+	 * @return boolean|null Success
 	 */
 	public function streamFile( $headers = [] ) {
 		$this->streamFileWithStatus( $headers )->isOK();
@@ -445,6 +445,9 @@ 
 	/** @var string Plain text formatted version of the error */
 	private $textMsg;
 
+	/**
+	 * @param string $msg
+	 */
 	function __construct( $msg, $width, $height /*, ... */ ) {
 		$args = array_slice( func_get_args(), 3 );
 		$htmlArgs = array_map( 'htmlspecialchars', $args );

includes/page/Article.php

Doc Comments +5 added lines, -5 removed lines

@@ -353,7 +353,7 @@ 
 	 * @note Code that wants to retrieve page content from the database should
 	 * use WikiPage::getContent().
 	 *
-	 * @return Content|null|bool
+	 * @return null|Content
 	 *
 	 * @since 1.21
 	 */
@@ -1529,7 +1529,7 @@ 
 	 * Chances are you should just be using the ParserOutput from
 	 * WikitextContent::getParserOutput instead of calling this for redirects.
 	 *
-	 * @param Title|array $target Destination(s) to redirect
+	 * @param Title $target Destination(s) to redirect
 	 * @param bool $appendSubtitle [optional]
 	 * @param bool $forceKnown Should the image be shown as a bluelink regardless of existence?
 	 * @return string Containing HTML with redirect link
@@ -2648,7 +2648,7 @@ 
 	 * @param string $reason
 	 * @param int $cascade
 	 * @param array $expiry
-	 * @return bool
+	 * @return Status
 	 */
 	public function updateRestrictions( $limit = [], $reason = '',
 		&$cascade = 0, $expiry = []
@@ -2705,7 +2705,7 @@ 
 
 	/**
 	 * @param bool $hasHistory
-	 * @return mixed
+	 * @return false|string
 	 */
 	public function generateReason( &$hasHistory ) {
 		$title = $this->mPage->getTitle();
@@ -2714,7 +2714,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 *
 	 * @deprecated since 1.24, use WikiPage::selectFields() instead
 	 */

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 ) {

includes/parser/Parser.php

Doc Comments +15 added lines, -10 removed lines

@@ -615,7 +615,7 @@ 
 	 * @since 1.25
 	 *
 	 * @param string $text Text extension wants to have parsed
-	 * @param bool|PPFrame $frame The frame to use for expanding any template variables
+	 * @param PPFrame $frame The frame to use for expanding any template variables
 	 * @return string Fully parsed HTML
 	 */
 	public function recursiveTagParseFully( $text, $frame = false ) {
@@ -633,7 +633,7 @@ 
 	 * @param ParserOptions $options
 	 * @param int|null $revid
 	 * @param bool|PPFrame $frame
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function preprocess( $text, Title $title = null,
 		ParserOptions $options, $revid = null, $frame = false
@@ -1969,6 +1969,10 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param string $component
+	 * @param string $unsafe
+	 */
 	private static function normalizeUrlComponent( $component, $unsafe ) {
 		$callback = function ( $matches ) use ( $unsafe ) {
 			$char = urldecode( $matches[0] );
@@ -2420,6 +2424,7 @@ 
 	 *
 	 * @param string $target The source of the link
 	 * @param string &$text The link text, modified as necessary
+	 * @param string $text
 	 * @return string The full name of the link
 	 * @private
 	 */
@@ -2445,7 +2450,7 @@ 
 	 * @private
 	 *
 	 * @param int $index
-	 * @param bool|PPFrame $frame
+	 * @param PPFrame $frame
 	 *
 	 * @throws MWException
 	 * @return string
@@ -2842,7 +2847,7 @@ 
 	 *
 	 * @param string $s
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function splitWhitespace( $s ) {
 		$ltrimmed = ltrim( $s );
@@ -2950,7 +2955,7 @@ 
 	 *   'expansion-depth-exceeded' (corresponding messages:
 	 *       'expansion-depth-exceeded-warning',
 	 *       'expansion-depth-exceeded-category')
-	 * @param string|int|null $current Current value
+	 * @param integer $current Current value
 	 * @param string|int|null $max Maximum allowed, when an explicit limit has been
 	 *	 exceeded, provide the values (optional)
 	 */
@@ -3954,7 +3959,7 @@ 
 	 * @param string $text
 	 * @param string $origText Original, untouched wikitext
 	 * @param bool $isMain
-	 * @return mixed|string
+	 * @return string
 	 * @private
 	 */
 	public function formatHeadings( $text, $origText, $isMain = true ) {
@@ -4525,7 +4530,7 @@ 
 	 * Check that the user's signature contains no bad XML
 	 *
 	 * @param string $text
-	 * @return string|bool An expanded string, or false if invalid.
+	 * @return string|false An expanded string, or false if invalid.
 	 */
 	public function validateSig( $text ) {
 		return Xml::isWellFormedXmlFragment( $text ) ? $text : false;
@@ -5067,7 +5072,7 @@ 
 	 *
 	 * @param Title $title
 	 * @param string $options
-	 * @param LinkHolderArray|bool $holders
+	 * @param LinkHolderArray $holders
 	 * @return string HTML
 	 */
 	public function makeImage( $title, $options, $holders = false ) {
@@ -5283,7 +5288,7 @@ 
 	/**
 	 * @param string $caption
 	 * @param LinkHolderArray|bool $holders
-	 * @return mixed|string
+	 * @return string
 	 */
 	protected function stripAltText( $caption, $holders ) {
 		# Strip bad stuff out of the title (tooltip).  We can't just use
@@ -5686,7 +5691,7 @@ 
 	 * Accessor for $mDefaultSort
 	 * Unlike getDefaultSort(), will return false if none is set
 	 *
-	 * @return string|bool
+	 * @return false|string
 	 */
 	public function getCustomDefaultSort() {
 		return $this->mDefaultSort;

includes/parser/ParserOutput.php

Doc Comments +42 added lines, -1 removed lines

@@ -416,6 +416,9 @@ 
 		return $this->mEnableOOUI;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	public function setText( $text ) {
 		return wfSetVar( $this->mText, $text );
 	}
@@ -436,32 +439,52 @@ 
 		return wfSetVar( $this->mSections, $toc );
 	}
 
+	/**
+	 * @param boolean $t
+	 */
 	public function setEditSectionTokens( $t ) {
 		return wfSetVar( $this->mEditSectionTokens, $t );
 	}
 
+	/**
+	 * @param string $policy
+	 */
 	public function setIndexPolicy( $policy ) {
 		return wfSetVar( $this->mIndexPolicy, $policy );
 	}
 
+	/**
+	 * @param string $tochtml
+	 */
 	public function setTOCHTML( $tochtml ) {
 		return wfSetVar( $this->mTOCHTML, $tochtml );
 	}
 
+	/**
+	 * @param string|false $timestamp
+	 */
 	public function setTimestamp( $timestamp ) {
 		return wfSetVar( $this->mTimestamp, $timestamp );
 	}
 
+	/**
+	 * @param boolean $flag
+	 */
 	public function setTOCEnabled( $flag ) {
 		return wfSetVar( $this->mTOCEnabled, $flag );
 	}
 
+	/**
+	 * @param string $c
+	 */
 	public function addCategory( $c, $sort ) {
 		$this->mCategories[$c] = $sort;
 	}
 
 	/**
 	 * @since 1.25
+	 * @param string $id
+	 * @param string $content
 	 */
 	public function setIndicator( $id, $content ) {
 		$this->mIndicators[$id] = $content;
@@ -478,10 +501,16 @@ 
 		$this->mEnableOOUI = $enable;
 	}
 
+	/**
+	 * @param string $t
+	 */
 	public function addLanguageLink( $t ) {
 		$this->mLanguageLinks[] = $t;
 	}
 
+	/**
+	 * @param string $s
+	 */
 	public function addWarning( $s ) {
 		$this->mWarnings[$s] = 1;
 	}
@@ -490,9 +519,16 @@ 
 		$this->mOutputHooks[] = [ $hook, $data ];
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function setNewSection( $value ) {
 		$this->mNewSection = (bool)$value;
 	}
+
+	/**
+	 * @param boolean $value
+	 */
 	public function hideNewSection( $value ) {
 		$this->mHideNewSection = (bool)$value;
 	}
@@ -829,6 +865,8 @@ 
 	 *    $parser->getOutput()->my_ext_foo = '...';
 	 * @endcode
 	 *
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function setProperty( $name, $value ) {
 		$this->mProperties[$name] = $value;
@@ -837,7 +875,7 @@ 
 	/**
 	 * @param string $name The property name to look up.
 	 *
-	 * @return mixed|bool The value previously set using setProperty(). False if null or no value
+	 * @return string The value previously set using setProperty(). False if null or no value
 	 * was set for the given property name.
 	 *
 	 * @note You need to use getProperties() to check for boolean and null properties.
@@ -952,6 +990,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $clock
+	 */
 	private static function getTimes( $clock = null ) {
 		$ret = [];
 		if ( !$clock || $clock === 'wall' ) {

includes/parser/Preprocessor_DOM.php

Doc Comments +4 added lines, -5 removed lines

@@ -1311,7 +1311,6 @@ 
 	/**
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ ) {
@@ -1343,7 +1342,6 @@ 
 	 * This previously called implodeWithFlags but has now been inlined to reduce stack depth
 	 *
 	 * @param string $sep
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return string
 	 */
 	public function implode( $sep /*, ... */ ) {
@@ -1375,7 +1373,6 @@ 
 	 * with implode()
 	 *
 	 * @param string $sep
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return array
 	 */
 	public function virtualImplode( $sep /*, ... */ ) {
@@ -1407,7 +1404,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return array
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
@@ -1570,7 +1566,7 @@ 
 
 	/**
 	 * @param Preprocessor $preprocessor
-	 * @param bool|PPFrame_DOM $parent
+	 * @param PPFrame_DOM $parent
 	 * @param array $numberedArgs
 	 * @param array $namedArgs
 	 * @param bool|Title $title
@@ -1741,6 +1737,9 @@ 
 
 	public $args;
 
+	/**
+	 * @param Preprocessor_DOM $preprocessor
+	 */
 	public function __construct( $preprocessor, $args ) {
 		parent::__construct( $preprocessor );
 		$this->args = $args;