wikimedia / mediawiki

includes/specials/SpecialUpload.php

Doc Comments +2 added lines, -2 removed lines

@@ -218,7 +218,7 @@ 
 	/**
 	 * Show the main upload form
 	 *
-	 * @param HTMLForm|string $form An HTMLForm instance or HTML string to show
+	 * @param UploadForm $form An HTMLForm instance or HTML string to show
 	 */
 	protected function showUploadForm( $form ) {
 		# Add links if file was previously deleted
@@ -601,7 +601,7 @@ 
 	 *
 	 * Note that the page target can be changed *on the form*, so our check
 	 * state can get out of sync.
-	 * @return bool|string
+	 * @return boolean
 	 */
 	protected function getWatchCheck() {
 		if ( $this->getUser()->getOption( 'watchdefault' ) ) {

includes/filerepo/file/File.php

Doc Comments +14 added lines, -14 removed lines

@@ -160,7 +160,7 @@ 
 	 * Most subclasses will want to call assertRepoDefined() here.
 	 *
 	 * @param Title|string|bool $title
-	 * @param FileRepo|bool $repo
+	 * @param FileRepo $repo
 	 */
 	function __construct( $title, $repo ) {
 		// Some subclasses do not use $title, but set name/title some other way
@@ -411,7 +411,7 @@ 
 	 * Most callers don't check the return value, but ForeignAPIFile::getPath
 	 * returns false.
 	 *
-	 * @return string|bool ForeignAPIFile::getPath can return false
+	 * @return string ForeignAPIFile::getPath can return false
 	 */
 	public function getPath() {
 		if ( !isset( $this->path ) ) {
@@ -457,7 +457,7 @@ 
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 *
 	 * @param int $page
-	 * @return int|bool
+	 * @return boolean
 	 */
 	public function getWidth( $page = 1 ) {
 		return false;
@@ -471,7 +471,7 @@ 
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 *
 	 * @param int $page
-	 * @return bool|int False on failure
+	 * @return boolean False on failure
 	 */
 	public function getHeight( $page = 1 ) {
 		return false;
@@ -484,7 +484,7 @@ 
 	 *
 	 * @param int $desiredWidth
 	 * @param int $page
-	 * @return bool|int
+	 * @return integer
 	 */
 	public function getThumbnailBucket( $desiredWidth, $page = 1 ) {
 		global $wgThumbnailBuckets, $wgThumbnailMinimumBucketDistance;
@@ -633,7 +633,7 @@ 
 	 * Get handler-specific metadata
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 * STUB
-	 * @return bool|array
+	 * @return boolean
 	 */
 	public function getMetadata() {
 		return false;
@@ -642,7 +642,7 @@ 
 	/**
 	 * Like getMetadata but returns a handler independent array of common values.
 	 * @see MediaHandler::getCommonMetaArray()
-	 * @return array|bool Array or false if not supported
+	 * @return boolean Array or false if not supported
 	 * @since 1.23
 	 */
 	public function getCommonMetaArray() {
@@ -660,7 +660,7 @@ 
 	 *
 	 * @param array|string $metadata Array or string of (serialized) metadata
 	 * @param int $version Version number.
-	 * @return array Array containing metadata, or what was passed to it on fail
+	 * @return ApiResult Array containing metadata, or what was passed to it on fail
 	 *   (unserializing if not array)
 	 */
 	public function convertMetadataVersion( $metadata, $version ) {
@@ -1359,7 +1359,7 @@ 
 	/**
 	 * Get a MediaHandler instance for this file
 	 *
-	 * @return MediaHandler|bool Registered MediaHandler for file's MIME type
+	 * @return MediaHandler Registered MediaHandler for file's MIME type
 	 *   or false if none found
 	 */
 	function getHandler() {
@@ -1782,7 +1782,7 @@ 
 	 * @param bool $watch
 	 * @param string|bool $timestamp
 	 * @param null|User $user User object or null to use $wgUser
-	 * @return bool
+	 * @return boolean|null
 	 * @throws MWException
 	 */
 	function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
@@ -1817,7 +1817,7 @@ 
 	}
 
 	/**
-	 * @param bool|IContextSource $context Context to use (optional)
+	 * @param IContextSource $context Context to use (optional)
 	 * @return bool
 	 */
 	function formatMetadata( $context = false ) {
@@ -1964,7 +1964,7 @@ 
 	 * Returns the number of pages of a multipage document, or false for
 	 * documents which aren't multipage documents
 	 *
-	 * @return bool|int
+	 * @return string|boolean
 	 */
 	function pageCount() {
 		if ( !isset( $this->pageCount ) ) {
@@ -2031,7 +2031,7 @@ 
 	/**
 	 * Get the HTML text of the description page, if available
 	 *
-	 * @param bool|Language $lang Optional language to fetch description in
+	 * @param Language $lang Optional language to fetch description in
 	 * @return string
 	 */
 	function getDescriptionText( $lang = false ) {
@@ -2103,7 +2103,7 @@ 
 	 * Returns false if the file does not have a description page, or retrieving the timestamp
 	 * would be expensive.
 	 * @since 1.25
-	 * @return string|bool
+	 * @return boolean
 	 */
 	public function getDescriptionTouched() {
 		return false;

includes/specials/SpecialSearch.php

Doc Comments +1 added lines, -1 removed lines

@@ -1356,7 +1356,7 @@
 	 * @since 1.18
 	 *
 	 * @param string $key
-	 * @param mixed $value
+	 * @param string $value
 	 */
 	public function setExtraParam( $key, $value ) {
 		$this->extraParams[$key] = $value;

includes/Linker.php

Doc Comments +2 added lines, -2 removed lines

@@ -1275,7 +1275,7 @@ 
 	 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
 	 *  For use with external changes.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 */
 	public static function formatComment(
 		$comment, $title = null, $local = false, $wikiId = null
@@ -1803,7 +1803,7 @@ 
 	 * Split a link trail, return the "inside" portion and the remainder of the trail
 	 * as a two-element array
 	 * @param string $trail
-	 * @return array
+	 * @return string[]
 	 */
 	static function splitTrail( $trail ) {
 		global $wgContLang;

includes/media/Bitmap.php

Doc Comments +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
 	 *
 	 * @param string $dstPath
 	 * @param bool $checkDstPath
-	 * @return string|Callable One of client, im, custom, gd, imext or an array( object, method )
+	 * @return string One of client, im, custom, gd, imext or an array( object, method )
 	 */
 	protected function getScalerType( $dstPath, $checkDstPath = true ) {
 		global $wgUseImageResize, $wgUseImageMagick, $wgCustomConvertCommand;
@@ -108,7 +108,7 @@ 
 	 * Get ImageMagick subsampling factors for the target JPEG pixel format.
 	 *
 	 * @param string $pixelFormat one of 'yuv444', 'yuv422', 'yuv420'
-	 * @return array of string keys
+	 * @return string[] of string keys
 	 */
 	protected function imageMagickSubsampling( $pixelFormat ) {
 		switch ( $pixelFormat ) {

includes/page/Article.php

Doc Comments +8 added lines, -8 removed lines

@@ -95,7 +95,7 @@ 
 	/**
 	 * Constructor from a page id
 	 * @param int $id Article ID to load
-	 * @return Article|null
+	 * @return Article
 	 */
 	public static function newFromID( $id ) {
 		$t = Title::newFromID( $id );
@@ -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
 	 */
@@ -441,7 +441,7 @@ 
 	 * on failure.
 	 *
 	 * @since 1.19
-	 * @return Revision|null
+	 * @return Revision
 	 */
 	public function getRevisionFetched() {
 		$this->fetchContentObject();
@@ -1533,7 +1533,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
@@ -1984,7 +1984,7 @@ 
 	 *
 	 * @param int|null $oldid Revision ID or null
 	 * @param User $user The relevant user
-	 * @return ParserOutput|bool ParserOutput or false if the given revision ID is not found
+	 * @return ParserOutput ParserOutput or false if the given revision ID is not found
 	 */
 	public function getParserOutput( $oldid = null, User $user = null ) {
 		// XXX: bypasses mParserOptions and thus setParserOptions()
@@ -2652,7 +2652,7 @@ 
 	 * @param string $reason
 	 * @param int $cascade
 	 * @param array $expiry
-	 * @return bool
+	 * @return Status
 	 */
 	public function updateRestrictions( $limit = [], $reason = '',
 		&$cascade = 0, $expiry = []
@@ -2709,7 +2709,7 @@ 
 
 	/**
 	 * @param bool $hasHistory
-	 * @return mixed
+	 * @return false|string
 	 */
 	public function generateReason( &$hasHistory ) {
 		$title = $this->mPage->getTitle();
@@ -2718,7 +2718,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 *
 	 * @deprecated since 1.24, use WikiPage::selectFields() instead
 	 */

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