wikimedia / mediawiki

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

includes/parser/Preprocessor_Hash.php

Doc Comments +7 added lines, -5 removed lines

@@ -688,6 +688,9 @@ 
 		return $rootNode;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	private static function addLiteral( array &$accum, $text ) {
 		$n = count( $accum );
 		if ( $n && is_string( $accum[$n - 1] ) ) {
@@ -1133,7 +1136,6 @@ 
 	/**
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ ) {
@@ -1164,7 +1166,6 @@ 
 	 * Implode with no flags specified
 	 * This previously called implodeWithFlags but has now been inlined to reduce stack depth
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implode( $sep /*, ... */ ) {
@@ -1196,7 +1197,6 @@ 
 	 * with implode()
 	 *
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return PPNode_Hash_Array
 	 */
 	public function virtualImplode( $sep /*, ... */ ) {
@@ -1229,7 +1229,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode $args,...
 	 * @return PPNode_Hash_Array
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
@@ -1392,7 +1391,7 @@ 
 
 	/**
 	 * @param Preprocessor $preprocessor
-	 * @param bool|PPFrame $parent
+	 * @param PPFrame_Hash $parent
 	 * @param array $numberedArgs
 	 * @param array $namedArgs
 	 * @param bool|Title $title
@@ -1572,6 +1571,9 @@ 
 
 	public $args;
 
+	/**
+	 * @param Preprocessor_Hash $preprocessor
+	 */
 	public function __construct( $preprocessor, $args ) {
 		parent::__construct( $preprocessor );
 		$this->args = $args;

includes/media/DjVuImage.php

Doc Comments +13 added lines

@@ -92,6 +92,10 @@ 
 		fclose( $file );
 	}
 
+	/**
+	 * @param resource $file
+	 * @param integer $indent
+	 */
 	private function dumpForm( $file, $length, $indent ) {
 		$start = ftell( $file );
 		$secondary = fread( $file, 4 );
@@ -165,6 +169,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $chunkLength
+	 */
 	private function skipChunk( $file, $chunkLength ) {
 		fseek( $file, $chunkLength, SEEK_CUR );
 
@@ -174,6 +181,9 @@ 
 		}
 	}
 
+	/**
+	 * @param resource $file
+	 */
 	private function getMultiPageInfo( $file, $formLength ) {
 		// For now, we'll just look for the first page in the file
 		// and report its information, hoping others are the same size.
@@ -368,6 +378,9 @@ 
 		return $xml;
 	}
 
+	/**
+	 * @param string $line
+	 */
 	function parseFormDjvu( $line, &$xml ) {
 		$parentLevel = strspn( $line, ' ' );
 		$line = strtok( "\n" );

includes/resourceloader/ResourceLoaderClientHtml.php

Doc Comments -1 removed lines

@@ -104,7 +104,6 @@
 	 *
 	 * See OutputPage::buildExemptModules() for use cases.
 	 *
-	 * @param array $modules Module state keyed by module name
 	 */
 	public function setExemptStates( array $states ) {
 		$this->exemptStates = $states;

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;
@@ -1144,7 +1144,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 row was not
+	 * @return integer The newly created page_id key; false if the row was not
 	 *   inserted, e.g. because the title already existed or because the specified
 	 *   page ID is already in use.
 	 */
@@ -1491,7 +1491,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
@@ -3370,7 +3370,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();
@@ -3445,7 +3445,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/resourceloader/ResourceLoader.php

Doc Comments +7 added lines, -4 removed lines

@@ -207,6 +207,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $filter
+	 * @param string $data
+	 */
 	private static function applyFilter( $filter, $data ) {
 		$data = trim( $data );
 		if ( $data ) {
@@ -309,7 +313,7 @@ 
 	 * @throws MWException If a duplicate module registration is attempted
 	 * @throws MWException If a module name contains illegal characters (pipes or commas)
 	 * @throws MWException If something other than a ResourceLoaderModule is being registered
-	 * @return bool False if there were any errors, in which case one or more modules were
+	 * @return boolean|null False if there were any errors, in which case one or more modules were
 	 *   not registered
 	 */
 	public function register( $name, $info = null ) {
@@ -573,7 +577,7 @@ 
 	/**
 	 * Get the list of sources.
 	 *
-	 * @return array Like [ id => load.php url, ... ]
+	 * @return string Like [ id => load.php url, ... ]
 	 */
 	public function getSources() {
 		return $this->sources;
@@ -610,7 +614,7 @@ 
 	 *
 	 * @since 1.26
 	 * @param ResourceLoaderContext $context
-	 * @param string[] $modules List of known module names
+	 * @param string[] $moduleNames List of known module names
 	 * @return string Hash
 	 */
 	public function getCombinedVersion( ResourceLoaderContext $context, array $moduleNames ) {
@@ -634,7 +638,6 @@ 
 	 *
 	 * @since 1.28
 	 * @param ResourceLoaderContext $context
-	 * @param string[] $modules List of module names
 	 * @return string Hash
 	 */
 	public function getExpectedVersionQuery( ResourceLoaderContext $context ) {

includes/page/ImagePage.php

Doc Comments +3 added lines, -3 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 ) {
@@ -1212,7 +1212,7 @@ 
 
 	/**
 	 * @see WikiFilePage::getFile
-	 * @return bool|File
+	 * @return string
 	 */
 	public function getFile() {
 		return $this->mPage->getFile();

includes/MediaWiki.php

Doc Comments +1 added lines, -1 removed lines

@@ -647,7 +647,7 @@
 	/**
 	 * @param string $url
 	 * @param IContextSource $context
-	 * @return string|bool Either "local" or "remote" if in the farm, false otherwise
+	 * @return false|string Either "local" or "remote" if in the farm, false otherwise
 	 */
 	private function getUrlDomainDistance( $url, IContextSource $context ) {
 		static $relevantKeys = [ 'host' => true, 'port' => true ];