wikimedia / mediawiki

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

includes/parser/ParserCache.php

Doc Comments +4 added lines, -4 removed lines

@@ -58,7 +58,7 @@ 
 	/**
 	 * @param WikiPage $article
 	 * @param string $hash
-	 * @return mixed|string
+	 * @return string
 	 */
 	protected function getParserOutputKey( $article, $hash ) {
 		global $wgRequest;
@@ -73,7 +73,7 @@ 
 
 	/**
 	 * @param WikiPage $article
-	 * @return mixed|string
+	 * @return string
 	 */
 	protected function getOptionsKey( $article ) {
 		$pageid = $article->getId();
@@ -128,7 +128,7 @@ 
 	 * @param WikiPage $article
 	 * @param ParserOptions $popts
 	 * @param bool $useOutdated (default true)
-	 * @return bool|mixed|string
+	 * @return false|string
 	 */
 	public function getKey( $article, $popts, $useOutdated = true ) {
 		global $wgCacheEpoch;
@@ -180,7 +180,7 @@ 
 	 * Retrieve the ParserOutput from ParserCache.
 	 * false if not found or outdated.
 	 *
-	 * @param WikiPage|Article $article
+	 * @param WikiPage $article
 	 * @param ParserOptions $popts
 	 * @param bool $useOutdated (default false)
 	 *

includes/specials/SpecialBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
 	 * If the user has already been blocked with similar settings, load that block
 	 * and change the defaults for the form fields to match the existing settings.
 	 * @param array $fields HTMLForm descriptor array
-	 * @return bool Whether fields were altered (that is, whether the target is
+	 * @return boolean|null Whether fields were altered (that is, whether the target is
 	 *     already blocked)
 	 */
 	protected function maybeAlterFormDefaults( &$fields ) {

includes/widget/SearchInputWidget.php

Doc Comments -7 removed lines

@@ -20,13 +20,6 @@
 
 	/**
 	 * @param array $config Configuration options
-	 * @param int|null $config['pushPending'] Whether the input should be visually marked as
-	 *  "pending", while requesting suggestions (default: true)
-	 * @param boolean|null $config['performSearchOnClick'] If true, the script will start a search
-	 *  whenever a user hits a suggestion. If false, the text of the suggestion is inserted into the
-	 *  text field only (default: true)
-	 * @param string $config['dataLocation'] Where the search input field will be
-	 *  used (header or content, default: header)
 	 */
 	public function __construct( array $config = [] ) {
 		$config = array_merge( [

includes/api/ApiBase.php

Doc Comments +13 added lines, -9 removed lines

@@ -408,7 +408,7 @@ 
 	 * Returning true will generate errors indicating that the API module needs
 	 * updating.
 	 *
-	 * @return string|false
+	 * @return boolean
 	 */
 	public function needsToken() {
 		return false;
@@ -421,7 +421,7 @@ 
 	 *
 	 * @since 1.24
 	 * @param array $params All supplied parameters for the module
-	 * @return string|array|null
+	 * @return string
 	 */
 	protected function getWebUITokenSalt( array $params ) {
 		return null;
@@ -486,7 +486,7 @@ 
 	/**
 	 * Get the parent of this module
 	 * @since 1.25
-	 * @return ApiBase|null
+	 * @return ApiMain
 	 */
 	public function getParent() {
 		return $this->isMain() ? null : $this->getMain();
@@ -621,6 +621,7 @@ 
 	/**
 	 * Set the continuation manager
 	 * @param ApiContinuationManager|null
+	 * @param ApiContinuationManager|null $manager
 	 */
 	public function setContinuationManager( $manager ) {
 		// Main module has setContinuationManager() method overridden
@@ -704,6 +705,7 @@ 
 	 *
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which exactly one must be set
+	 * @param string $required
 	 */
 	public function requireOnlyOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -730,6 +732,7 @@ 
 	 *
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which at most one must be set
+	 * @param string $required
 	 */
 	public function requireMaxOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -753,6 +756,7 @@ 
 	 * @since 1.23
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which at least one must be set
+	 * @param string $required
 	 */
 	public function requireAtLeastOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -2531,7 +2535,7 @@ 
 	 * "apihelp-{$this->getModulePath()}-description".
 	 *
 	 * @deprecated since 1.25
-	 * @return Message|string|array
+	 * @return boolean
 	 */
 	protected function getDescription() {
 		return false;
@@ -2567,7 +2571,7 @@ 
 	 * that value, and boolean false means "no examples".
 	 *
 	 * @deprecated since 1.25, use getExamplesMessages() instead
-	 * @return bool|string|array
+	 * @return boolean
 	 */
 	protected function getExamples() {
 		return false;
@@ -2576,7 +2580,7 @@ 
 	/**
 	 * Generates help message for this module, or false if there is no description
 	 * @deprecated since 1.25
-	 * @return string|bool
+	 * @return string
 	 */
 	public function makeHelpMsg() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2686,7 +2690,7 @@ 
 	 * Generates the parameter descriptions for this module, to be displayed in the
 	 * module's help.
 	 * @deprecated since 1.25
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function makeHelpMsgParameters() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2877,7 +2881,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileTime() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2900,7 +2904,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileDBTime() {
 		wfDeprecated( __METHOD__, '1.25' );