wikimedia / mediawiki

includes/page/Article.php

Doc Comments +7 added lines, -7 removed lines

@@ -95,7 +95,7 @@ 
 	/**
 	 * Constructor from a page id
 	 * @param int $id Article ID to load
-	 * @return Article|null
+	 * @return Article
 	 */
 	public static function newFromID( $id ) {
 		$t = Title::newFromID( $id );
@@ -353,7 +353,7 @@ 
 	 * @note Code that wants to retrieve page content from the database should
 	 * use WikiPage::getContent().
 	 *
-	 * @return Content|null|bool
+	 * @return null|Content
 	 *
 	 * @since 1.21
 	 */
@@ -441,7 +441,7 @@ 
 	 * on failure.
 	 *
 	 * @since 1.19
-	 * @return Revision|null
+	 * @return Revision
 	 */
 	public function getRevisionFetched() {
 		$this->fetchContentObject();
@@ -1531,7 +1531,7 @@ 
 	 * Chances are you should just be using the ParserOutput from
 	 * WikitextContent::getParserOutput instead of calling this for redirects.
 	 *
-	 * @param Title|array $target Destination(s) to redirect
+	 * @param Title $target Destination(s) to redirect
 	 * @param bool $appendSubtitle [optional]
 	 * @param bool $forceKnown Should the image be shown as a bluelink regardless of existence?
 	 * @return string Containing HTML with redirect link
@@ -2119,7 +2119,7 @@ 
 	 * @param string $reason
 	 * @param int $cascade
 	 * @param array $expiry
-	 * @return bool
+	 * @return Status
 	 */
 	public function updateRestrictions( $limit = array(), $reason = '',
 		&$cascade = 0, $expiry = array()
@@ -2176,7 +2176,7 @@ 
 
 	/**
 	 * @param bool $hasHistory
-	 * @return mixed
+	 * @return false|string
 	 */
 	public function generateReason( &$hasHistory ) {
 		$title = $this->mPage->getTitle();
@@ -2187,7 +2187,7 @@ 
 	// ****** B/C functions for static methods ( __callStatic is PHP>=5.3 ) ****** //
 
 	/**
-	 * @return array
+	 * @return string[]
 	 *
 	 * @deprecated since 1.24, use WikiPage::selectFields() instead
 	 */

includes/page/CategoryPage.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 	/**
 	 * Constructor from a page id
 	 * @param int $id Article ID to load
-	 * @return CategoryPage|null
+	 * @return CategoryPage
 	 */
 	public static function newFromID( $id ) {
 		$t = Title::newFromID( $id );

includes/page/WikiFilePage.php

Doc Comments +6 added lines, -3 removed lines

@@ -34,6 +34,9 @@ 
 	protected $mFileLoaded = false;		    // !<
 	protected $mDupes = null;				// !<
 
+	/**
+	 * @param Title $title
+	 */
 	public function __construct( $title ) {
 		parent::__construct( $title );
 		$this->mDupes = null;
@@ -66,7 +69,7 @@ 
 	}
 
 	/**
-	 * @return mixed|null|Title
+	 * @return Title|null
 	 */
 	public function getRedirectTarget() {
 		$this->loadFile();
@@ -120,7 +123,7 @@ 
 	}
 
 	/**
-	 * @return bool|File
+	 * @return File
 	 */
 	public function getFile() {
 		$this->loadFile();
@@ -192,7 +195,7 @@ 
 	 * For foreign API files (InstantCommons), this is not supported currently.
 	 * Results will include hidden categories.
 	 *
-	 * @return TitleArray|Title[]
+	 * @return TitleArrayFromResult|null
 	 * @since 1.23
 	 */
 	public function getForeignCategories() {

includes/pager/TablePager.php

Doc Comments +2 added lines, -2 removed lines

@@ -220,7 +220,7 @@ 
 	 *
 	 * @protected
 	 *
-	 * @param object $row The database result row
+	 * @param stdClass $row The database result row
 	 * @return array Array of attribute => value
 	 */
 	function getRowAttrs( $row ) {
@@ -387,7 +387,7 @@ 
 	 * Resubmits all defined elements of the query string, except for a
 	 * blacklist, passed in the $blacklist parameter.
 	 *
-	 * @param array $blacklist Parameters from the request query which should not be resubmitted
+	 * @param string[] $blacklist Parameters from the request query which should not be resubmitted
 	 * @return string HTML fragment
 	 */
 	function getHiddenFields( $blacklist = array() ) {

includes/parser/CoreParserFunctions.php

Doc Comments +4 added lines, -1 removed lines

@@ -264,6 +264,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $func
+	 */
 	public static function urlFunction( $func, $s = '', $arg = null ) {
 		$title = Title::newFromText( $s );
 		# Due to order of execution of a lot of bits, the values might be encoded
@@ -521,7 +524,7 @@ 
 	 * to not break PHP 5.3
 	 * @param Parser $parser
 	 * @param string $title
-	 * @return mixed|string
+	 * @return string
 	 */
 	public static function mwnamespace( $parser, $title = null ) {
 		$t = Title::newFromText( $title );

includes/parser/DateFormatter.php

Doc Comments +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
 	/**
 	 * Get a DateFormatter object
 	 *
-	 * @param Language|string|null $lang In which language to format the date
+	 * @param Language $lang In which language to format the date
 	 * 		Defaults to the site content language
 	 * @return DateFormatter
 	 */
@@ -147,7 +147,7 @@ 
 	/**
 	 * @param string $preference User preference
 	 * @param string $text Text to reformat
-	 * @param array $options Array can contain 'linked' and/or 'match-whole'
+	 * @param string[] $options Array can contain 'linked' and/or 'match-whole'
 	 *
 	 * @return string
 	 */

includes/parser/LinkHolderArray.php

Doc Comments +3 added lines, -3 removed lines

@@ -57,7 +57,7 @@ 
 	 * serializing at present.
 	 *
 	 * Compact the titles, only serialize the text form.
-	 * @return array
+	 * @return string[]
 	 */
 	public function __sleep() {
 		foreach ( $this->internals as &$nsLinks ) {
@@ -119,8 +119,8 @@ 
 	 * strings will be returned.
 	 *
 	 * @param LinkHolderArray $other
-	 * @param array $texts Array of strings
-	 * @return array
+	 * @param string[] $texts Array of strings
+	 * @return string[]
 	 */
 	public function mergeForeign( $other, $texts ) {
 		$this->tempIdOffset = $idOffset = $this->parent->nextLinkID();

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