wikimedia / mediawiki

includes/specials/SpecialWatchlist.php

Doc Comments +7 added lines, -1 removed lines

@@ -293,6 +293,9 @@ 
 		);
 	}
 
+	/**
+	 * @param FormOptions $opts
+	 */
 	protected function runMainQueryHook( &$tables, &$fields, &$conds, &$query_options,
 		&$join_conds, $opts
 	) {
@@ -516,6 +519,9 @@ 
 		$this->setBottomText( $opts );
 	}
 
+	/**
+	 * @param FormOptions $options
+	 */
 	function cutoffselector( $options ) {
 		// Cast everything to strings immediately, so that we know all of the values have the same
 		// precision, and can be compared with '==='. 2/24 has a few more decimal places than its
@@ -625,7 +631,7 @@ 
 	 * Count the number of items on a user's watchlist
 	 *
 	 * @param IDatabase $dbr A database connection
-	 * @return int
+	 * @return double
 	 */
 	protected function countItems( $dbr ) {
 		# Fetch the raw count

includes/specials/SpecialWhatlinkshere.php

Doc Comments +13 added lines

@@ -303,10 +303,17 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $level
+	 */
 	protected function listStart( $level ) {
 		return Xml::openElement( 'ul', ( $level ? array() : array( 'id' => 'mw-whatlinkshere-list' ) ) );
 	}
 
+	/**
+	 * @param Title $nt
+	 * @param Title $target
+	 */
 	protected function listItem( $row, $nt, $target, $notClose = false ) {
 		$dirmark = $this->getLanguage()->getDirMark();
 
@@ -405,6 +412,9 @@ 
 		return $this->getLanguage()->pipeList( $links );
 	}
 
+	/**
+	 * @param string $text
+	 */
 	function makeSelfLink( $text, $query ) {
 		return Linker::linkKnown(
 			$this->selfTitle,
@@ -414,6 +424,9 @@ 
 		);
 	}
 
+	/**
+	 * @param integer $prevId
+	 */
 	function getPrevNext( $prevId, $nextId ) {
 		$currentLimit = $this->opts->getValue( 'limit' );
 		$prev = $this->msg( 'whatlinkshere-prev' )->numParams( $currentLimit )->escaped();

includes/Status.php

Doc Comments +4 added lines, -4 removed lines

@@ -147,7 +147,7 @@ 
 	 * Add an error, do not set fatal flag
 	 * This can be used for non-fatal errors
 	 *
-	 * @param string|Message $message Message name or object
+	 * @param string|false $message Message name or object
 	 */
 	public function error( $message /*, parameters... */ ) {
 		call_user_func_array( array( $this->sv, 'error' ), func_get_args() );
@@ -400,7 +400,7 @@ 
 	/**
 	 * Returns true if the specified message is present as a warning or error
 	 *
-	 * @param string|Message $message Message key or object to search for
+	 * @param string $message Message key or object to search for
 	 *
 	 * @return bool
 	 */
@@ -415,8 +415,8 @@ 
 	 * Note, due to the lack of tools for comparing Message objects, this
 	 * function will not work when using a Message object as the search parameter.
 	 *
-	 * @param Message|string $source Message key or object to search for
-	 * @param Message|string $dest Replacement message key or object
+	 * @param string $source Message key or object to search for
+	 * @param string $dest Replacement message key or object
 	 * @return bool Return true if the replacement was done, false otherwise.
 	 */
 	public function replaceMessage( $source, $dest ) {

includes/Title.php

Doc Comments +14 added lines, -15 removed lines

@@ -161,7 +161,7 @@ 
 	 * Avoid usage of this singleton by using TitleValue
 	 * and the associated services when possible.
 	 *
-	 * @return TitleParser
+	 * @return string
 	 */
 	private static function getTitleParser() {
 		global $wgContLang, $wgLocalInterwikis;
@@ -370,7 +370,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;
@@ -610,7 +610,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 );
@@ -896,7 +896,7 @@ 
 	 * (e.g. TitleValues cannot represent page-local links that have a
 	 * fragment but no title text).
 	 *
-	 * @return TitleValue|null
+	 * @return TitleValue
 	 */
 	public function getTitleValue() {
 		if ( $this->mTitleValue === null ) {
@@ -1127,7 +1127,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
 	 */
@@ -1916,7 +1915,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.
 	 */
@@ -2017,7 +2016,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
 	 */
@@ -2408,7 +2407,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
@@ -3932,7 +3931,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 );
@@ -4072,8 +4071,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.
 	 */
@@ -4185,9 +4184,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.
@@ -4343,7 +4342,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;
@@ -4747,7 +4746,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	public function __sleep() {
 		return array(

includes/TitleArrayFromResult.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
 
 	public $current;
 
+	/**
+	 * @param ResultWrapper $res
+	 */
 	function __construct( $res ) {
 		$this->res = $res;
 		$this->key = 0;

includes/upload/UploadBase.php

Doc Comments +2 added lines, -3 removed lines

@@ -265,7 +265,7 @@ 
 
 	/**
 	 * @param string $srcPath The source path
-	 * @return string|bool The real path if it was a virtual URL Returns false on failure
+	 * @return string|false The real path if it was a virtual URL Returns false on failure
 	 */
 	function getRealPath( $srcPath ) {
 		$repo = RepoGroup::singleton()->getLocalRepo();
@@ -1513,7 +1513,6 @@ 
 	 * Check a block of CSS or CSS fragment for anything that looks like
 	 * it is bringing in remote code.
 	 * @param string $value a string of CSS
-	 * @param bool $propOnly only check css properties (start regex with :)
 	 * @return bool true if the CSS contains an illegal string, false if otherwise
 	 */
 	private static function checkCssFragment( $value ) {
@@ -1887,7 +1886,7 @@ 
 	 * format, presumably.
 	 *
 	 * @param ApiResult $result
-	 * @return array Image info
+	 * @return User Image info
 	 */
 	public function getImageInfo( $result ) {
 		$file = $this->getLocalFile();

includes/upload/UploadFromChunks.php

Doc Comments +3 added lines

@@ -333,6 +333,9 @@
 		return $storeStatus;
 	}
 
+	/**
+	 * @param integer $index
+	 */
 	private function getChunkFileKey( $index = null ) {
 		if ( $index === null ) {
 			$index = $this->getChunkIndex();

includes/upload/UploadFromStash.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	private $repo;
 
 	/**
-	 * @param User|bool $user Default: false
+	 * @param User $user Default: false
 	 * @param UploadStash|bool $stash Default: false
 	 * @param FileRepo|bool $repo Default: false
 	 */

includes/upload/UploadStash.php

Doc Comments +2 added lines, -2 removed lines

@@ -170,7 +170,7 @@ 
 	 * Getter for file metadata.
 	 *
 	 * @param string $key Key under which file information is stored
-	 * @return array
+	 * @return string
 	 */
 	public function getMetadata( $key ) {
 		$this->getFile( $key );
@@ -200,7 +200,7 @@ 
 	 * @throws UploadStashBadPathException
 	 * @throws UploadStashFileException
 	 * @throws UploadStashNotLoggedInException
-	 * @return UploadStashFile|null File, or null on failure
+	 * @return UploadStashFile File, or null on failure
 	 */
 	public function stashFile( $path, $sourceType = null ) {
 		if ( !is_file( $path ) ) {