wikimedia / mediawiki

includes/specials/SpecialNewpages.php

Doc Comments +6 added lines

@@ -39,6 +39,9 @@ 
 		parent::__construct( 'Newpages' );
 	}
 
+	/**
+	 * @param string $par
+	 */
 	protected function setup( $par ) {
 		// Options
 		$opts = new FormOptions();
@@ -457,6 +460,9 @@ 
 		}
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function feedItemAuthor( $row ) {
 		return isset( $row->rc_user_text ) ? $row->rc_user_text : '';
 	}

includes/parser/Preprocessor.php

Doc Comments +7 added lines, -8 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();
@@ -84,7 +85,7 @@ 
 	 *
 	 * @param string $text
 	 * @param int $flags
-	 * @return PPNode_Hash_Tree|bool
+	 * @return false|string
 	 */
 	protected function cacheGetTree( $text, $flags ) {
 		$config = RequestContext::getMain()->getConfig();
@@ -128,7 +129,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
 	 */
@@ -182,7 +183,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
@@ -201,7 +202,6 @@ 
 	 * Implode with flags for expand()
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ );
@@ -209,7 +209,6 @@ 
 	/**
 	 * Implode with no flags specified
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implode( $sep /*, ... */ );
@@ -218,7 +217,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 /*, ... */ );
@@ -228,7 +226,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode $args,...
 	 * @return PPNode
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
@@ -260,7 +257,7 @@ 
 
 	/**
 	 * Get an argument to this frame by name
-	 * @param int|string $name
+	 * @param string $name
 	 * @return string|bool
 	 */
 	public function getArgument( $name );
@@ -289,6 +286,7 @@ 
 	 * to respect it, and it may be removed in the future.
 	 *
 	 * @param bool $flag
+	 * @return void
 	 */
 	public function setVolatile( $flag = true );
 
@@ -325,6 +323,7 @@ 
 	 *
 	 * @see self::getTTL()
 	 * @param int $ttl
+	 * @return void
 	 */
 	public function setTTL( $ttl );
 

includes/parser/Preprocessor_DOM.php

Doc Comments +6 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 /*, ... */ ) {
@@ -1530,7 +1526,7 @@ 
 	/**
 	 * Get the TTL
 	 *
-	 * @return int|null
+	 * @return integer
 	 */
 	public function getTTL() {
 		return $this->ttl;
@@ -1555,7 +1551,7 @@ 
 
 	/**
 	 * @param Preprocessor $preprocessor
-	 * @param bool|PPFrame_DOM $parent
+	 * @param PPFrame_DOM $parent
 	 * @param array $numberedArgs
 	 * @param array $namedArgs
 	 * @param bool|Title $title
@@ -1726,6 +1722,9 @@ 
 
 	public $args;
 
+	/**
+	 * @param Preprocessor_DOM $preprocessor
+	 */
 	public function __construct( $preprocessor, $args ) {
 		parent::__construct( $preprocessor );
 		$this->args = $args;
@@ -1833,7 +1832,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/content/ContentHandler.php

Doc Comments +3 added lines, -3 removed lines

@@ -654,7 +654,7 @@ 
 	 *
 	 * @param IContextSource $context Context to use, anything else will be ignored.
 	 * @param int $old Revision ID we want to show and diff with.
-	 * @param int|string $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
+	 * @param integer $new Either a revision ID or one of the strings 'cur', 'prev' or 'next'.
 	 * @param int $rcid FIXME: Deprecated, no longer used. Defaults to 0.
 	 * @param bool $refreshCache If set, refreshes the diff cache. Defaults to false.
 	 * @param bool $unhide If set, allow viewing deleted revs. Defaults to false.
@@ -792,7 +792,7 @@ 
 	 * @param Content $myContent One of the page's conflicting contents.
 	 * @param Content $yourContent One of the page's conflicting contents.
 	 *
-	 * @return Content|bool Always false.
+	 * @return boolean Always false.
 	 */
 	public function merge3( Content $oldContent, Content $myContent, Content $yourContent ) {
 		return false;
@@ -884,7 +884,7 @@ 
 	 * @param Title $title The page's title
 	 * @param bool &$hasHistory Whether the page has a history
 	 *
-	 * @return mixed String containing deletion reason or empty string, or
+	 * @return false|string String containing deletion reason or empty string, or
 	 *    boolean false if no revision occurred
 	 *
 	 * @todo &$hasHistory is extremely ugly, it's here because

includes/libs/stats/NullStatsdDataFactory.php

Doc Comments -2 removed lines

@@ -53,7 +53,6 @@ 
 	 * This function creates a 'increment' StatsdData object.
 	 *
 	 * @param string|array $key The metric(s) to increment.
-	 * @param float|1      $sampleRate The rate (0-1) for sampling.
 	 *
 	 * @return array
 	 **/
@@ -66,7 +65,6 @@ 
 	 *
 	 *
 	 * @param string|array $key The metric(s) to decrement.
-	 * @param float|1      $sampleRate The rate (0-1) for sampling.
 	 *
 	 * @return mixed
 	 **/

includes/collation/Collation.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
 	 * @since 1.16.3
 	 * @throws MWException
 	 * @param string $collationName
-	 * @return Collation
+	 * @return string
 	 */
 	public static function factory( $collationName ) {
 		switch ( $collationName ) {

includes/collation/IcuCollation.php

Doc Comments +5 added lines, -1 removed lines

@@ -167,6 +167,9 @@ 
 	 */
 	const RECORD_LENGTH = 14;
 
+	/**
+	 * @param string $locale
+	 */
 	public function __construct( $locale ) {
 		if ( !extension_loaded( 'intl' ) ) {
 			throw new MWException( 'An ICU collation was requested, ' .
@@ -388,6 +391,7 @@ 
 
 	/**
 	 * @since 1.16.3
+	 * @param integer $index
 	 */
 	public function getLetterByIndex( $index ) {
 		if ( $this->firstLetterData === null ) {
@@ -449,7 +453,7 @@ 
 	 * currently in use, or false when it can't be determined.
 	 *
 	 * @since 1.21
-	 * @return string|bool
+	 * @return false|string
 	 */
 	static function getUnicodeVersionForICU() {
 		$icuVersion = IcuCollation::getICUVersion();

includes/site/SiteSQLStore.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
 	 *             instead.
 	 *
 	 * @param null $sitesTable IGNORED
-	 * @param null $cache IGNORED
+	 * @param null|BagOStuff $cache IGNORED
 	 *
 	 * @return SiteStore
 	 */

includes/OutputPage.php

Doc Comments +16 added lines, -10 removed lines

@@ -430,7 +430,7 @@ 
 	 * one is set.
 	 *
 	 * @since 1.25
-	 * @return bool|string
+	 * @return boolean
 	 */
 	public function getCanonicalUrl() {
 		return $this->mCanonicalUrl;
@@ -996,7 +996,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();
@@ -1610,7 +1610,7 @@ 
 	 * Get the timestamp of displayed revision.
 	 * This will be null if not filled by setRevisionTimestamp().
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function getRevisionTimestamp() {
 		return $this->mRevisionTimestamp;
@@ -1619,7 +1619,7 @@ 
 	/**
 	 * Set the displayed file version
 	 *
-	 * @param File|bool $file
+	 * @param File $file
 	 * @return mixed Previous value
 	 */
 	public function setFileVersion( $file ) {
@@ -1965,7 +1965,7 @@ 
 	/**
 	 * Get the list of cookies that will influence on the cache
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheVaryCookies() {
 		static $cookies;
@@ -2342,7 +2342,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
@@ -2368,8 +2368,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 = [] ) {
@@ -2565,6 +2565,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function showFatalError( $message ) {
 		$this->prepareErrorPage( $this->msg( 'internalerror' ) );
 
@@ -2583,6 +2586,9 @@ 
 		$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function showFileDeleteError( $name ) {
 		$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
 	}
@@ -2609,7 +2615,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
 	 */
@@ -3856,7 +3862,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