wikimedia / mediawiki

includes/parser/ParserOutput.php

Doc Comments +42 added lines, -1 removed lines

@@ -416,6 +416,9 @@ 
 		return $this->mEnableOOUI;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	public function setText( $text ) {
 		return wfSetVar( $this->mText, $text );
 	}
@@ -436,32 +439,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;
@@ -478,10 +501,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;
 	}
@@ -490,9 +519,16 @@ 
 		$this->mOutputHooks[] = [ $hook, $data ];
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function setNewSection( $value ) {
 		$this->mNewSection = (bool)$value;
 	}
+
+	/**
+	 * @param boolean $value
+	 */
 	public function hideNewSection( $value ) {
 		$this->mHideNewSection = (bool)$value;
 	}
@@ -829,6 +865,8 @@ 
 	 *    $parser->getOutput()->my_ext_foo = '...';
 	 * @endcode
 	 *
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function setProperty( $name, $value ) {
 		$this->mProperties[$name] = $value;
@@ -837,7 +875,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.
@@ -952,6 +990,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $clock
+	 */
 	private static function getTimes( $clock = null ) {
 		$ret = [];
 		if ( !$clock || $clock === 'wall' ) {

includes/parser/Preprocessor_Hash.php

Doc Comments +7 added lines, -5 removed lines

@@ -688,6 +688,9 @@ 
 		return $rootNode;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	private static function addLiteral( array &$accum, $text ) {
 		$n = count( $accum );
 		if ( $n && is_string( $accum[$n - 1] ) ) {
@@ -1133,7 +1136,6 @@ 
 	/**
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ ) {
@@ -1164,7 +1166,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 /*, ... */ ) {
@@ -1196,7 +1197,6 @@ 
 	 * with implode()
 	 *
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return PPNode_Hash_Array
 	 */
 	public function virtualImplode( $sep /*, ... */ ) {
@@ -1229,7 +1229,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode $args,...
 	 * @return PPNode_Hash_Array
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
@@ -1392,7 +1391,7 @@ 
 
 	/**
 	 * @param Preprocessor $preprocessor
-	 * @param bool|PPFrame $parent
+	 * @param PPFrame_Hash $parent
 	 * @param array $numberedArgs
 	 * @param array $namedArgs
 	 * @param bool|Title $title
@@ -1572,6 +1571,9 @@ 
 
 	public $args;
 
+	/**
+	 * @param Preprocessor_Hash $preprocessor
+	 */
 	public function __construct( $preprocessor, $args ) {
 		parent::__construct( $preprocessor );
 		$this->args = $args;

includes/Title.php

Doc Comments +12 added lines, -13 removed lines

@@ -365,7 +365,7 @@ 
 	 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
 	 * whether to include page_content_model.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	protected static function getSelectFields() {
 		global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
@@ -558,7 +558,7 @@ 
 	 * Get the prefixed DB key associated with an ID
 	 *
 	 * @param int $id The page_id of the article
-	 * @return Title|null An object representing the article, or null if no such article was found
+	 * @return null|string An object representing the article, or null if no such article was found
 	 */
 	public static function nameOf( $id ) {
 		$dbr = wfGetDB( DB_SLAVE );
@@ -1079,7 +1079,6 @@ 
 	/**
 	 * Returns true if the title is inside one of the specified namespaces.
 	 *
-	 * @param int $namespaces,... The namespaces to check for
 	 * @return bool
 	 * @since 1.19
 	 */
@@ -1889,7 +1888,7 @@ 
 	 *   - quick  : does cheap permission checks from slaves (usable for GUI creation)
 	 *   - full   : does cheap and expensive checks possibly from a slave
 	 *   - secure : does cheap and expensive checks, using the master as needed
-	 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
+	 * @param string[] $ignoreErrors Array of Strings Set this to a list of message keys
 	 *   whose corresponding errors may be ignored.
 	 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
 	 */
@@ -1990,7 +1989,7 @@ 
 	 * Add the resulting error code to the errors array
 	 *
 	 * @param array $errors List of current errors
-	 * @param array $result Result of errors
+	 * @param string $result Result of errors
 	 *
 	 * @return array List of errors
 	 */
@@ -2381,7 +2380,7 @@ 
 	 *
 	 * @param string $action The action to check
 	 * @param bool $short Short circuit on first error
-	 * @return array List of errors
+	 * @return string[] List of errors
 	 */
 	private function missingPermissionError( $action, $short ) {
 		// We avoid expensive display logic for quickUserCan's and such
@@ -3920,7 +3919,7 @@ 
 	 *
 	 * @param int $revId Revision ID. Get the revision that was before this one.
 	 * @param int $flags Title::GAID_FOR_UPDATE
-	 * @return int|bool Old revision ID, or false if none exists
+	 * @return integer Old revision ID, or false if none exists
 	 */
 	public function getPreviousRevisionID( $revId, $flags = 0 ) {
 		$db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
@@ -4060,8 +4059,8 @@ 
 	 * Get the number of revisions between the given revision.
 	 * Used for diffs and other things that really need it.
 	 *
-	 * @param int|Revision $old Old revision or rev ID (first before range)
-	 * @param int|Revision $new New revision or rev ID (first after range)
+	 * @param Revision $old Old revision or rev ID (first before range)
+	 * @param Revision $new New revision or rev ID (first after range)
 	 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
 	 * @return int Number of revisions between these revisions.
 	 */
@@ -4173,9 +4172,9 @@ 
 	 * Used for diffs and other things that really need it.
 	 *
 	 * @param int|Revision $old Old revision or rev ID (first before range by default)
-	 * @param int|Revision $new New revision or rev ID (first after range by default)
+	 * @param Revision $new New revision or rev ID (first after range by default)
 	 * @param int $limit Maximum number of authors
-	 * @param string|array $options (Optional): Single option, or an array of options:
+	 * @param string $options (Optional): Single option, or an array of options:
 	 *     'include_old' Include $old in the range; $new is excluded.
 	 *     'include_new' Include $new in the range; $old is excluded.
 	 *     'include_both' Include both $old and $new in the range.
@@ -4331,7 +4330,7 @@ 
 	/**
 	 * Get the default message text or false if the message doesn't exist
 	 *
-	 * @return string|bool
+	 * @return false|string
 	 */
 	public function getDefaultMessageText() {
 		global $wgContLang;
@@ -4778,7 +4777,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	public function __sleep() {
 		return [

includes/filebackend/lockmanager/DBLockManager.php

Doc Comments +5 added lines

@@ -113,6 +113,11 @@
 		return $status;
 	}
 
+	/**
+	 * @param string $lockSrv
+	 *
+	 * @return Status
+	 */
 	abstract protected function doGetLocksOnServer( $lockSrv, array $paths, $type );
 
 	protected function freeLocksOnServer( $lockSrv, array $pathsByType ) {

includes/collation/IcuCollation.php

Doc Comments +6 added lines, -1 removed lines

@@ -182,6 +182,9 @@ 
 	 */
 	const RECORD_LENGTH = 14;
 
+	/**
+	 * @param string $locale
+	 */
 	public function __construct( $locale ) {
 		if ( !extension_loaded( 'intl' ) ) {
 			throw new MWException( 'An ICU collation was requested, ' .
@@ -413,6 +416,8 @@ 
 
 	/**
 	 * @since 1.16.3
+	 * @param integer $index
+	 * @return string
 	 */
 	public function getLetterByIndex( $index ) {
 		return $this->getFirstLetterData()['chars'][$index];
@@ -466,7 +471,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/revisiondelete/RevDelArchivedFileItem.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
 	/** @var LocalFile */
 	protected $lockFile;
 
+	/**
+	 * @param RevDelArchivedFileList $list
+	 */
 	public function __construct( $list, $row ) {
 		RevDelItem::__construct( $list, $row );
 		$this->file = ArchivedFile::newFromRow( $row );