wikimedia / mediawiki

includes/parser/Parser.php

Doc Comments +16 added lines, -11 removed lines

@@ -617,7 +617,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 ) {
@@ -635,7 +635,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
@@ -866,7 +866,7 @@ 
 
 	/**
 	 * Get the language object for language conversion
-	 * @return Language|null
+	 * @return Language
 	 */
 	public function getConverterLanguage() {
 		return $this->getTargetLanguage();
@@ -1938,6 +1938,10 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param string $component
+	 * @param string $unsafe
+	 */
 	private static function normalizeUrlComponent( $component, $unsafe ) {
 		$callback = function ( $matches ) use ( $unsafe ) {
 			$char = urldecode( $matches[0] );
@@ -2398,6 +2402,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
 	 */
@@ -2901,7 +2906,7 @@ 
 	 * @private
 	 *
 	 * @param int $index
-	 * @param bool|PPFrame $frame
+	 * @param PPFrame $frame
 	 *
 	 * @throws MWException
 	 * @return string
@@ -3298,7 +3303,7 @@ 
 	 *
 	 * @param string $s
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function splitWhitespace( $s ) {
 		$ltrimmed = ltrim( $s );
@@ -3406,7 +3411,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)
 	 */
@@ -4402,7 +4407,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 ) {
@@ -4971,7 +4976,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;
@@ -5513,7 +5518,7 @@ 
 	 *
 	 * @param Title $title
 	 * @param string $options
-	 * @param LinkHolderArray|bool $holders
+	 * @param LinkHolderArray $holders
 	 * @return string HTML
 	 */
 	public function makeImage( $title, $options, $holders = false ) {
@@ -5731,7 +5736,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
@@ -6134,7 +6139,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/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;
@@ -177,7 +177,7 @@ 
 	 * Retrieve the ParserOutput from ParserCache.
 	 * false if not found or outdated.
 	 *
-	 * @param WikiPage|Article $article
+	 * @param Page $article
 	 * @param ParserOptions $popts
 	 * @param bool $useOutdated (default false)
 	 *

includes/parser/ParserOptions.php

Doc Comments +29 added lines, -1 removed lines

@@ -356,6 +356,9 @@ 
 		return $this->mPreSaveTransform;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getDateFormat() {
 		$this->optionUsed( 'dateformat' );
 		if ( !isset( $this->mDateFormat ) ) {
@@ -429,6 +432,9 @@ 
 		return wfSetVar( $this->mDateFormat, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setEditSection( $x ) {
 		return wfSetVar( $this->mEditSection, $x );
 	}
@@ -445,6 +451,9 @@ 
 		return wfSetVar( $this->mTidy, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setInterfaceMessage( $x ) {
 		return wfSetVar( $this->mInterfaceMessage, $x );
 	}
@@ -453,6 +462,9 @@ 
 		return wfSetVar( $this->mTargetLanguage, $x, true );
 	}
 
+	/**
+	 * @param integer $x
+	 */
 	public function setMaxIncludeSize( $x ) {
 		return wfSetVar( $this->mMaxIncludeSize, $x );
 	}
@@ -474,11 +486,18 @@ 
 		return wfSetVar( $this->mExpensiveParserFunctionLimit, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setRemoveComments( $x ) {
 		return wfSetVar( $this->mRemoveComments, $x );
 	}
 
 	/* @since 1.24 */
+
+	/**
+	 * @param Closure $x
+	 */
 	public function setCurrentRevisionCallback( $x ) {
 		return wfSetVar( $this->mCurrentRevisionCallback, $x );
 	}
@@ -491,6 +510,9 @@ 
 		return wfSetVar( $this->mEnableLimitReport, $x );
 	}
 
+	/**
+	 * @param string|false $x
+	 */
 	public function setTimestamp( $x ) {
 		return wfSetVar( $this->mTimestamp, $x );
 	}
@@ -531,6 +553,9 @@ 
 		return wfSetVar( $this->mPreSaveTransform, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setIsPreview( $x ) {
 		return wfSetVar( $this->mIsPreview, $x );
 	}
@@ -539,6 +564,9 @@ 
 		return wfSetVar( $this->mIsSectionPreview, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setIsPrintable( $x ) {
 		return wfSetVar( $this->mIsPrintable, $x );
 	}
@@ -723,7 +751,7 @@ 
 	 * Returns the full array of options that would have been used by
 	 * in 1.16.
 	 * Used to get the old parser cache entries when available.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function legacyOptions() {
 		return array(

includes/parser/ParserOutput.php

Doc Comments +48 added lines, -1 removed lines

@@ -386,6 +386,9 @@ 
 		return $this->mEnableOOUI;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	public function setText( $text ) {
 		return wfSetVar( $this->mText, $text );
 	}
@@ -398,6 +401,9 @@ 
 		return wfSetVar( $this->mCategories, $cl );
 	}
 
+	/**
+	 * @param boolean|string $t
+	 */
 	public function setTitleText( $t ) {
 		return wfSetVar( $this->mTitleText, $t );
 	}
@@ -406,32 +412,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;
@@ -448,10 +474,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;
 	}
@@ -460,9 +492,16 @@ 
 		$this->mOutputHooks[] = array( $hook, $data );
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function setNewSection( $value ) {
 		$this->mNewSection = (bool)$value;
 	}
+
+	/**
+	 * @param boolean $value
+	 */
 	public function hideNewSection( $value ) {
 		$this->mHideNewSection = (bool)$value;
 	}
@@ -736,6 +775,9 @@ 
 		$this->mFlags[$flag] = true;
 	}
 
+	/**
+	 * @param string $flag
+	 */
 	public function getFlag( $flag ) {
 		return isset( $this->mFlags[$flag] );
 	}
@@ -799,6 +841,8 @@ 
 	 *    $parser->getOutput()->my_ext_foo = '...';
 	 * @endcode
 	 *
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function setProperty( $name, $value ) {
 		$this->mProperties[$name] = $value;
@@ -807,7 +851,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.
@@ -980,6 +1024,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $clock
+	 */
 	private static function getTimes( $clock = null ) {
 		$ret = array();
 		if ( !$clock || $clock === 'wall' ) {

includes/parser/Preprocessor.php

Doc Comments +6 added lines, -7 removed lines

@@ -56,6 +56,7 @@ 
 	 *
 	 * @param string $text
 	 * @param int $flags
+	 * @param string $tree
 	 */
 	protected function cacheSetTree( $text, $flags, $tree ) {
 		$config = RequestContext::getMain()->getConfig();
@@ -86,7 +87,7 @@ 
 	 *
 	 * @param string $text
 	 * @param int $flags
-	 * @return PPNode_Hash_Tree|bool
+	 * @return false|string
 	 */
 	protected function cacheGetTree( $text, $flags ) {
 		$config = RequestContext::getMain()->getConfig();
@@ -132,7 +133,7 @@ 
 	 * Create a new custom frame for programmatic use of parameter replacement
 	 * as used in some extensions.
 	 *
-	 * @param array $args
+	 * @param boolean $args
 	 *
 	 * @return PPFrame
 	 */
@@ -186,7 +187,7 @@ 
 
 	/**
 	 * Expand a document tree node, caching the result on its parent with the given key
-	 * @param string|int $key
+	 * @param string $key
 	 * @param string|PPNode $root
 	 * @param int $flags
 	 * @return string
@@ -205,7 +206,6 @@ 
 	 * Implode with flags for expand()
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ );
@@ -213,7 +213,6 @@ 
 	/**
 	 * Implode with no flags specified
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implode( $sep /*, ... */ );
@@ -222,7 +221,6 @@ 
 	 * Makes an object that, when expand()ed, will be the same as one obtained
 	 * with implode()
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return PPNode
 	 */
 	public function virtualImplode( $sep /*, ... */ );
@@ -232,7 +230,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode $args,...
 	 * @return PPNode
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
@@ -293,6 +290,7 @@ 
 	 * to respect it, and it may be removed in the future.
 	 *
 	 * @param bool $flag
+	 * @return void
 	 */
 	public function setVolatile( $flag = true );
 
@@ -329,6 +327,7 @@ 
 	 *
 	 * @see self::getTTL()
 	 * @param int $ttl
+	 * @return void
 	 */
 	public function setTTL( $ttl );
 

includes/parser/Preprocessor_DOM.php

Doc Comments +12 added lines, -7 removed lines

@@ -1296,7 +1296,6 @@ 
 	/**
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ ) {
@@ -1328,7 +1327,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 /*, ... */ ) {
@@ -1360,7 +1358,6 @@ 
 	 * with implode()
 	 *
 	 * @param string $sep
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return array
 	 */
 	public function virtualImplode( $sep /*, ... */ ) {
@@ -1392,7 +1389,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return array
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
@@ -1526,7 +1522,7 @@ 
 	/**
 	 * Get the TTL
 	 *
-	 * @return int|null
+	 * @return integer
 	 */
 	public function getTTL() {
 		return $this->ttl;
@@ -1551,7 +1547,7 @@ 
 
 	/**
 	 * @param Preprocessor $preprocessor
-	 * @param bool|PPFrame_DOM $parent
+	 * @param PPFrame_DOM $parent
 	 * @param array $numberedArgs
 	 * @param array $namedArgs
 	 * @param bool|Title $title
@@ -1646,6 +1642,9 @@ 
 		return $arguments;
 	}
 
+	/**
+	 * @param string $index
+	 */
 	public function getNumberedArgument( $index ) {
 		if ( !isset( $this->numberedArgs[$index] ) ) {
 			return false;
@@ -1660,6 +1659,9 @@ 
 		return $this->numberedExpansionCache[$index];
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function getNamedArgument( $name ) {
 		if ( !isset( $this->namedArgs[$name] ) ) {
 			return false;
@@ -1710,6 +1712,9 @@ 
 
 	public $args;
 
+	/**
+	 * @param Preprocessor_DOM $preprocessor
+	 */
 	public function __construct( $preprocessor, $args ) {
 		parent::__construct( $preprocessor );
 		$this->args = $args;
@@ -1813,7 +1818,7 @@ 
 	/**
 	 * @param string $type
 	 *
-	 * @return bool|PPNode_DOM
+	 * @return PPNode_DOM
 	 */
 	public function getChildrenOfType( $type ) {
 		return new self( $this->getXPath()->query( $type, $this->node ) );

includes/parser/Preprocessor_Hash.php

Doc Comments +9 added lines, -7 removed lines

@@ -1184,7 +1184,6 @@ 
 	/**
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ ) {
@@ -1215,7 +1214,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 /*, ... */ ) {
@@ -1247,7 +1245,6 @@ 
 	 * with implode()
 	 *
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return PPNode_Hash_Array
 	 */
 	public function virtualImplode( $sep /*, ... */ ) {
@@ -1280,7 +1277,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode $args,...
 	 * @return PPNode_Hash_Array
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
@@ -1423,7 +1419,7 @@ 
 	/**
 	 * Get the TTL
 	 *
-	 * @return int|null
+	 * @return integer
 	 */
 	public function getTTL() {
 		return $this->ttl;
@@ -1443,7 +1439,7 @@ 
 
 	/**
 	 * @param Preprocessor $preprocessor
-	 * @param bool|PPFrame $parent
+	 * @param PPFrame_Hash $parent
 	 * @param array $numberedArgs
 	 * @param array $namedArgs
 	 * @param bool|Title $title
@@ -1623,6 +1619,9 @@ 
 
 	public $args;
 
+	/**
+	 * @param Preprocessor_Hash $preprocessor
+	 */
 	public function __construct( $preprocessor, $args ) {
 		parent::__construct( $preprocessor );
 		$this->args = $args;
@@ -1838,7 +1837,7 @@ 
 	 * Split an "<h>" node
 	 *
 	 * @throws MWException
-	 * @return array
+	 * @return string
 	 */
 	public function splitHeading() {
 		if ( $this->name !== 'h' ) {
@@ -2020,6 +2019,9 @@ 
 
 	public $name, $value, $nextSibling;
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct( $name, $value ) {
 		$this->name = $name;
 		$this->value = $value;

includes/parser/StripState.php

Doc Comments +5 added lines, -5 removed lines

@@ -87,7 +87,7 @@ 
 
 	/**
 	 * @param string $text
-	 * @return mixed
+	 * @return string
 	 */
 	public function unstripGeneral( $text ) {
 		return $this->unstripType( 'general', $text );
@@ -95,7 +95,7 @@ 
 
 	/**
 	 * @param string $text
-	 * @return mixed
+	 * @return string
 	 */
 	public function unstripNoWiki( $text ) {
 		return $this->unstripType( 'nowiki', $text );
@@ -103,7 +103,7 @@ 
 
 	/**
 	 * @param string $text
-	 * @return mixed
+	 * @return string
 	 */
 	public function unstripBoth( $text ) {
 		$text = $this->unstripType( 'general', $text );
@@ -114,7 +114,7 @@ 
 	/**
 	 * @param string $type
 	 * @param string $text
-	 * @return mixed
+	 * @return string
 	 */
 	protected function unstripType( $type, $text ) {
 		// Shortcut
@@ -204,7 +204,7 @@ 
 	 *
 	 * @param StripState $otherState
 	 * @param array $texts
-	 * @return array
+	 * @return string[]
 	 */
 	public function merge( $otherState, $texts ) {
 		$mergePrefix = wfRandomString( 16 );

includes/poolcounter/PoolCounterWork.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 
 	/**
 	 * Retrieve the work from cache
-	 * @return mixed Work result or false
+	 * @return boolean Work result or false
 	 */
 	public function getCachedWork() {
 		return false;
@@ -56,7 +56,7 @@ 
 	/**
 	 * A work not so good (eg. expired one) but better than an error
 	 * message.
-	 * @return mixed Work result or false
+	 * @return boolean Work result or false
 	 */
 	public function fallback() {
 		return false;