wikimedia / mediawiki

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

includes/Preferences.php

Doc Comments +1 added lines

@@ -1084,6 +1084,7 @@
 
 	/**
 	 * Dummy, kept for backwards-compatibility.
+	 * @param User $user
 	 */
 	static function miscPreferences( $user, IContextSource $context, &$defaultPreferences ) {
 	}

includes/PrefixSearch.php

Doc Comments +5 added lines, -1 removed lines

@@ -131,7 +131,7 @@ 
 	 * When implemented in a descendant class, receives an array of titles as strings and returns
 	 * either an unmodified array or an array of Title objects corresponding to strings received.
 	 *
-	 * @param array $strings
+	 * @param string[] $strings
 	 *
 	 * @return array
 	 */
@@ -164,6 +164,10 @@ 
 		return $this->strings( $this->handleResultFromHook( $srchres, $namespaces, $search, $limit ) );
 	}
 
+	/**
+	 * @param string $search
+	 * @param integer $limit
+	 */
 	private function handleResultFromHook( $srchres, $namespaces, $search, $limit ) {
 		$rescorer = new SearchExactMatchRescorer();
 		return $rescorer->rescore( $search, $namespaces, $srchres, $limit );

includes/profiler/TransactionProfiler.php

Doc Comments +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 	 * With conflicting expectations, the most narrow ones will be used
 	 *
 	 * @param array $expects Map of (event => limit)
-	 * @param $fname
+	 * @param string $fname
 	 * @since 1.26
 	 */
 	public function setExpectations( array $expects, $fname ) {