wikimedia / mediawiki

includes/htmlform/fields/HTMLButtonField.php

Doc Comments +1 added lines, -1 removed lines

@@ -125,7 +125,7 @@
 
 	/**
 	 * IE<8 has bugs with <button>, so we'll need to avoid them.
-	 * @return bool Whether the request is from a bad version of IE
+	 * @return integer Whether the request is from a bad version of IE
 	 */
 	private function isBadIE() {
 		$request = $this->mParent

includes/htmlform/fields/HTMLCheckMatrix.php

Doc Comments +4 added lines, -1 removed lines

@@ -75,7 +75,7 @@ 
 	 * mParams['rows'] is an array with row labels as keys and row tags as values.
 	 * mParams['columns'] is an array with column labels as keys and column tags as values.
 	 *
-	 * @param array $value Array of the options that should be checked
+	 * @param string $value Array of the options that should be checked
 	 *
 	 * @return string
 	 */
@@ -151,6 +151,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param boolean $checked
+	 */
 	protected function getOneCheckbox( $checked, $attribs ) {
 		if ( $this->mParent instanceof OOUIHTMLForm ) {
 			return new OOUI\CheckboxInputWidget( array(

includes/htmlform/fields/HTMLMultiSelectField.php

Doc Comments +3 added lines

@@ -63,6 +63,9 @@
 		return $html;
 	}
 
+	/**
+	 * @param boolean $checked
+	 */
 	protected function getOneCheckbox( $checked, $attribs, $label ) {
 		if ( $this->mParent instanceof OOUIHTMLForm ) {
 			if ( $this->mOptionsLabelsNotFromMessage ) {

includes/htmlform/fields/HTMLRadioField.php

Doc Comments +3 added lines

@@ -55,6 +55,9 @@
 		) + $this->getAttributes( array( 'disabled', 'tabindex' ), array( 'tabindex' => 'tabIndex' ) ) );
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function formatOptions( $options, $value ) {
 		$html = '';
 

includes/utils/AutoloadGenerator.php

Doc Comments +3 added lines, -2 removed lines

@@ -158,8 +158,8 @@ 
 	/**
 	 * Generates a PHP file setting up autoload information.
 	 *
-	 * @param {string} $commandName Command name to include in comment
-	 * @param {string} $filename of PHP file to put autoload information in.
+	 * @param string $commandName Command name to include in comment
+	 * @param string $filename of PHP file to put autoload information in.
 	 */
 	protected function generatePHPAutoload( $commandName, $filename ) {
 		// No existing JSON file found; update/generate PHP file
@@ -320,6 +320,7 @@ 
 
 	/**
 	 * @var string $code PHP code (including <?php) to detect class names from
+	 * @param string $code
 	 * @return array List of FQCN detected within the tokens
 	 */
 	public function getClasses( $code ) {

includes/media/MediaHandler.php

Doc Comments +4 added lines, -4 removed lines

@@ -41,7 +41,7 @@ 
 	 * Get a MediaHandler for a given MIME type from the instance cache
 	 *
 	 * @param string $type
-	 * @return MediaHandler|bool
+	 * @return File
 	 */
 	static function getHandler( $type ) {
 		return MediaWikiServices::getInstance()
@@ -173,7 +173,7 @@ 
 	 *
 	 * @note This method is currently unused.
 	 * @param File $image
-	 * @return string
+	 * @return boolean
 	 */
 	function getMetadataType( $image ) {
 		return false;
@@ -285,7 +285,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();
@@ -625,7 +625,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 +15 added lines, -9 removed lines

@@ -652,7 +652,7 @@ 
 	 * Add one or more head items to the output
 	 *
 	 * @since 1.28
-	 * @param string|string[] $value Raw HTML
+	 * @param string|string[] $values Raw HTML
 	 */
 	public function addHeadItems( $values ) {
 		$this->mHeadItems = array_merge( $this->mHeadItems, (array)$values );
@@ -969,7 +969,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();
@@ -1587,7 +1587,7 @@ 
 	/**
 	 * Set the displayed file version
 	 *
-	 * @param File|bool $file
+	 * @param File $file
 	 * @return mixed Previous value
 	 */
 	public function setFileVersion( $file ) {
@@ -1936,7 +1936,7 @@ 
 	/**
 	 * Get the list of cookies that will influence on the cache
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheVaryCookies() {
 		static $cookies;
@@ -2315,7 +2315,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
@@ -2341,8 +2341,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 = [] ) {
@@ -2538,6 +2538,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function showFatalError( $message ) {
 		$this->prepareErrorPage( $this->msg( 'internalerror' ) );
 
@@ -2556,6 +2559,9 @@ 
 		$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function showFileDeleteError( $name ) {
 		$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
 	}
@@ -2582,7 +2588,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
 	 */
@@ -3843,7 +3849,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/ImagePage.php

Doc Comments +2 added lines, -2 removed lines

@@ -296,7 +296,7 @@ 
 	 *
 	 * Omit noarticletext if sharedupload; text will be fetched from the
 	 * shared upload server if possible.
-	 * @return string
+	 * @return null|Content
 	 */
 	public function getContentObject() {
 		$this->loadFile();
@@ -637,7 +637,7 @@ 
 	 * Make the text under the image to say what size preview
 	 *
 	 * @param $params array parameters for thumbnail
-	 * @param $sizeLinkBigImagePreview HTML for the current size
+	 * @param string $sizeLinkBigImagePreview HTML for the current size
 	 * @return string HTML output
 	 */
 	private function getThumbPrevText( $params, $sizeLinkBigImagePreview ) {

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 );
@@ -645,6 +648,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 ) {
@@ -818,7 +822,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 );
@@ -930,6 +934,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @return callable
+	 */
 	function getDefault() {
 		if ( isset( $this->mDefault ) ) {
 			return $this->mDefault;
@@ -1103,7 +1110,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
 	 */