wikimedia / mediawiki

includes/page/WikiPage.php

Doc Comments +8 added lines, -8 removed lines

@@ -261,7 +261,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;
@@ -522,7 +522,7 @@ 
 
 	/**
 	 * Get the page_links_updated field
-	 * @return string|null Containing GMT timestamp
+	 * @return string Containing GMT timestamp
 	 */
 	public function getLinksTimestamp() {
 		if ( !$this->mDataLoaded ) {
@@ -1050,7 +1050,7 @@ 
 	 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
 	 *   get the current revision (default value)
 	 *
-	 * @return ParserOutput|bool ParserOutput or false if the revision was not found
+	 * @return ParserOutput ParserOutput or false if the revision was not found
 	 */
 	public function getParserOutput( ParserOptions $parserOptions, $oldid = null ) {
 
@@ -1151,7 +1151,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' );
@@ -1408,7 +1408,7 @@ 
 	 * @param int|null $baseRevId
 	 *
 	 * @throws MWException
-	 * @return Content|null New complete article content, or null if error.
+	 * @return Content New complete article content, or null if error.
 	 *
 	 * @since 1.24
 	 */
@@ -1494,7 +1494,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
@@ -3320,7 +3320,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();
@@ -3395,7 +3395,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/ParserOutput.php

Doc Comments +49 added lines, -2 removed lines

@@ -382,7 +382,7 @@ 
 	}
 
 	/**
-	 * @return string|null TS_MW timestamp of the revision content
+	 * @return string TS_MW timestamp of the revision content
 	 */
 	public function getTimestamp() {
 		return $this->mTimestamp;
@@ -400,6 +400,9 @@ 
 		return $this->mEnableOOUI;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	public function setText( $text ) {
 		return wfSetVar( $this->mText, $text );
 	}
@@ -412,6 +415,9 @@ 
 		return wfSetVar( $this->mCategories, $cl );
 	}
 
+	/**
+	 * @param boolean|string $t
+	 */
 	public function setTitleText( $t ) {
 		return wfSetVar( $this->mTitleText, $t );
 	}
@@ -420,32 +426,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;
@@ -462,10 +488,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;
 	}
@@ -474,9 +506,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;
 	}
@@ -750,6 +789,9 @@ 
 		$this->mFlags[$flag] = true;
 	}
 
+	/**
+	 * @param string $flag
+	 */
 	public function getFlag( $flag ) {
 		return isset( $this->mFlags[$flag] );
 	}
@@ -813,6 +855,8 @@ 
 	 *    $parser->getOutput()->my_ext_foo = '...';
 	 * @endcode
 	 *
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function setProperty( $name, $value ) {
 		$this->mProperties[$name] = $value;
@@ -821,7 +865,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.
@@ -936,6 +980,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $clock
+	 */
 	private static function getTimes( $clock = null ) {
 		$ret = [];
 		if ( !$clock || $clock === 'wall' ) {

includes/api/ApiQueryImageInfo.php

Doc Comments +2 added lines, -2 removed lines

@@ -103,7 +103,7 @@ 
 
 	/**
 	 * Fields in the oldimage table
-	 * @return array
+	 * @return string[]
 	 */
 	static function selectFields() {
 		return array(
@@ -232,7 +232,7 @@ 
 
 	/**
 	 * @param string $prefix
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheFields( $prefix = 'img_' ) {
 		$fields = parent::getCacheFields( $prefix );

includes/EditPage.php

Doc Comments +14 added lines, -7 removed lines

@@ -2183,7 +2183,7 @@ 
 	 *
 	 * @param string $text
 	 *
-	 * @return string|bool Matching string or false
+	 * @return string|false Matching string or false
 	 */
 	public static function matchSpamRegex( $text ) {
 		global $wgSpamRegex;
@@ -2197,7 +2197,7 @@ 
 	 *
 	 * @param string $text
 	 *
-	 * @return string|bool Matching string or false
+	 * @return string|false Matching string or false
 	 */
 	public static function matchSummarySpamRegex( $text ) {
 		global $wgSummarySpamRegex;
@@ -2208,7 +2208,7 @@ 
 	/**
 	 * @param string $text
 	 * @param array $regexes
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected static function matchSpamRegexInternal( $text, $regexes ) {
 		foreach ( $regexes as $regex ) {
@@ -2448,7 +2448,7 @@ 
 	 * $this->allowNonTextContent to true to allow editing of non-textual
 	 * content.
 	 *
-	 * @param string|null|bool $text Text to unserialize
+	 * @param false|string $text Text to unserialize
 	 * @return Content The content object created from $text. If $text was false
 	 *   or null, false resp. null will be  returned instead.
 	 *
@@ -3139,6 +3139,10 @@ 
 		$this->showTextbox( $this->textbox2, 'wpTextbox2', [ 'tabindex' => 6, 'readonly' ] );
 	}
 
+	/**
+	 * @param string $text
+	 * @param string $name
+	 */
 	protected function showTextbox( $text, $name, $customAttribs = [] ) {
 		global $wgOut, $wgUser;
 
@@ -3168,6 +3172,9 @@ 
 		$wgOut->addHTML( Html::textarea( $name, $wikitext, $attribs ) );
 	}
 
+	/**
+	 * @param string $previewOutput
+	 */
 	protected function displayPreviewArea( $previewOutput, $isOnTop = false ) {
 		global $wgOut;
 		$classes = [];
@@ -3754,7 +3761,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return Title[]
 	 */
 	function getTemplates() {
 		if ( $this->preview || $this->section != '' ) {
@@ -3917,7 +3924,7 @@ 
 	 * @param array $checked Array of checkbox => bool, where bool indicates the checked
 	 *                 status of the checkbox
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getCheckboxes( &$tabindex, $checked ) {
 		global $wgUser, $wgUseMediaWikiUIEverywhere;
@@ -3981,7 +3988,7 @@ 
 	 *
 	 * @param int $tabindex Current tabindex
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getEditButtons( &$tabindex ) {
 		$buttons = [];

includes/libs/CSSMin.php

Doc Comments +2 added lines, -2 removed lines

@@ -100,7 +100,7 @@ 
 	 * @param bool $ie8Compat By default, a data URI will only be produced if it can be made short
 	 *     enough to fit in Internet Explorer 8 (and earlier) URI length limit (32,768 bytes). Pass
 	 *     `false` to remove this limitation.
-	 * @return string|bool Image contents encoded as a data URI or false.
+	 * @return false|string Image contents encoded as a data URI or false.
 	 */
 	public static function encodeImageAsDataURI( $file, $type = null, $ie8Compat = true ) {
 		// Fast-fail for files that definitely exceed the maximum data URI length
@@ -128,7 +128,7 @@ 
 	 * @param string $contents File contents to encode.
 	 * @param string $type File's MIME type.
 	 * @param bool $ie8Compat See encodeImageAsDataURI().
-	 * @return string|bool Image contents encoded as a data URI or false.
+	 * @return string|false Image contents encoded as a data URI or false.
 	 */
 	public static function encodeStringAsDataURI( $contents, $type, $ie8Compat = true ) {
 		// Try #1: Non-encoded data URI

includes/media/TransformationalImageHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -563,7 +563,7 @@
 	 * @param array $params Rotate parameters.
 	 *   'rotation' clockwise rotation in degrees, allowed are multiples of 90
 	 * @since 1.24 Is non-static. From 1.21 it was static
-	 * @return bool
+	 * @return MediaTransformError
 	 */
 	public function rotate( $file, $params ) {
 		return new MediaTransformError( 'thumbnail_error', 0, 0,

includes/specials/SpecialMediaStatistics.php

Doc Comments +2 added lines, -2 removed lines

@@ -100,7 +100,7 @@ 
 	 *
 	 * It's important that img_media_type come first, otherwise the
 	 * tables will be fragmented.
-	 * @return Array Fields to sort by
+	 * @return string[] Fields to sort by
 	 */
 	function getOrderFields() {
 		return [ 'img_media_type', 'count(*)', 'img_major_mime', 'img_minor_mime' ];
@@ -170,7 +170,7 @@ 
 	 *
 	 * @param string $mime mime type (e.g. image/jpeg)
 	 * @param int $count Number of images of this type
-	 * @param int $totalBytes Total space for images of this type
+	 * @param integer $bytes
 	 */
 	protected function outputTableRow( $mime, $count, $bytes ) {
 		$mimeSearch = SpecialPage::getTitleFor( 'MIMEsearch', $mime );