wikimedia / mediawiki

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;

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

includes/resourceloader/ResourceLoader.php

Doc Comments +6 added lines, -2 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 ) {
@@ -572,7 +576,7 @@ 
 	/**
 	 * Get the list of sources.
 	 *
-	 * @return array Like array( id => load.php url, .. )
+	 * @return string Like array( id => load.php url, .. )
 	 */
 	public function getSources() {
 		return $this->sources;