wikimedia / mediawiki

includes/Category.php

Doc Comments +7 added lines, -7 removed lines

@@ -205,42 +205,42 @@ 
 	}
 
 	/**
-	 * @return mixed DB key name, or false on failure
+	 * @return boolean DB key name, or false on failure
 	 */
 	public function getName() {
 		return $this->getX( 'mName' );
 	}
 
 	/**
-	 * @return mixed Category ID, or false on failure
+	 * @return boolean Category ID, or false on failure
 	 */
 	public function getID() {
 		return $this->getX( 'mID' );
 	}
 
 	/**
-	 * @return mixed Total number of member pages, or false on failure
+	 * @return boolean Total number of member pages, or false on failure
 	 */
 	public function getPageCount() {
 		return $this->getX( 'mPages' );
 	}
 
 	/**
-	 * @return mixed Number of subcategories, or false on failure
+	 * @return boolean Number of subcategories, or false on failure
 	 */
 	public function getSubcatCount() {
 		return $this->getX( 'mSubcats' );
 	}
 
 	/**
-	 * @return mixed Number of member files, or false on failure
+	 * @return boolean Number of member files, or false on failure
 	 */
 	public function getFileCount() {
 		return $this->getX( 'mFiles' );
 	}
 
 	/**
-	 * @return Title|bool Title for this category, or false on failure.
+	 * @return Title Title for this category, or false on failure.
 	 */
 	public function getTitle() {
 		if ( $this->mTitle ) {
@@ -260,7 +260,7 @@ 
 	 * category sort key $offset.
 	 * @param int $limit
 	 * @param string $offset
-	 * @return TitleArray TitleArray object for category members.
+	 * @return TitleArrayFromResult|null TitleArray object for category members.
 	 */
 	public function getMembers( $limit = false, $offset = '' ) {
 

includes/content/ContentHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -659,7 +659,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.
@@ -889,7 +889,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/db/DatabaseMssql.php

Doc Comments +5 added lines, -5 removed lines

@@ -373,8 +373,8 @@ 
 	/**
 	 * SELECT wrapper
 	 *
-	 * @param mixed $table Array or string, table name(s) (prefix auto-added)
-	 * @param mixed $vars Array or string, field name(s) to be retrieved
+	 * @param string $table Array or string, table name(s) (prefix auto-added)
+	 * @param string $vars Array or string, field name(s) to be retrieved
 	 * @param mixed $conds Array or string, condition(s) for WHERE
 	 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
 	 * @param array $options Associative array of options (e.g.
@@ -382,7 +382,7 @@ 
 	 *   code for list of supported stuff
 	 * @param array $join_conds Associative array of table join conditions
 	 *   (optional) (e.g. array( 'page' => array('LEFT JOIN','page_latest=rev_id') )
-	 * @return mixed Database result resource (feed to Database::fetchObject
+	 * @return MssqlResultWrapper Database result resource (feed to Database::fetchObject
 	 *   or whatever), or false on failure
 	 * @throws DBQueryError
 	 * @throws DBUnexpectedError
@@ -871,7 +871,7 @@ 
 	 *
 	 * @param string $sql SQL query we will append the limit too
 	 * @param int $limit The SQL limit
-	 * @param bool|int $offset The SQL offset (default false)
+	 * @param string|false $offset The SQL offset (default false)
 	 * @return array|string
 	 * @throws DBUnexpectedError
 	 */
@@ -1189,7 +1189,7 @@ 
 	/**
 	 * @param array $options An associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 */
 	public function makeSelectOptions( $options ) {
 		$tailOpts = '';

includes/export/DumpFileOutput.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 	}
 
 	/**
-	 * @param array $newname
+	 * @param string $newname
 	 * @return string
 	 * @throws MWException
 	 */

includes/filerepo/file/File.php

Doc Comments +8 added lines, -8 removed lines

@@ -160,7 +160,7 @@ 
 	 * Most subclasses will want to call assertRepoDefined() here.
 	 *
 	 * @param Title|string|bool $title
-	 * @param FileRepo|bool $repo
+	 * @param FileRepo $repo
 	 */
 	function __construct( $title, $repo ) {
 		// Some subclasses do not use $title, but set name/title some other way
@@ -484,7 +484,7 @@ 
 	 *
 	 * @param int $desiredWidth
 	 * @param int $page
-	 * @return bool|int
+	 * @return integer
 	 */
 	public function getThumbnailBucket( $desiredWidth, $page = 1 ) {
 		global $wgThumbnailBuckets, $wgThumbnailMinimumBucketDistance;
@@ -642,7 +642,7 @@ 
 	/**
 	 * Like getMetadata but returns a handler independent array of common values.
 	 * @see MediaHandler::getCommonMetaArray()
-	 * @return array|bool Array or false if not supported
+	 * @return ApiResult Array or false if not supported
 	 * @since 1.23
 	 */
 	public function getCommonMetaArray() {
@@ -660,7 +660,7 @@ 
 	 *
 	 * @param array|string $metadata Array or string of (serialized) metadata
 	 * @param int $version Version number.
-	 * @return array Array containing metadata, or what was passed to it on fail
+	 * @return ApiResult Array containing metadata, or what was passed to it on fail
 	 *   (unserializing if not array)
 	 */
 	public function convertMetadataVersion( $metadata, $version ) {
@@ -1781,7 +1781,7 @@ 
 	 * @param bool $watch
 	 * @param string|bool $timestamp
 	 * @param null|User $user User object or null to use $wgUser
-	 * @return bool
+	 * @return boolean|null
 	 * @throws MWException
 	 */
 	function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
@@ -1816,7 +1816,7 @@ 
 	}
 
 	/**
-	 * @param bool|IContextSource $context Context to use (optional)
+	 * @param IContextSource $context Context to use (optional)
 	 * @return bool
 	 */
 	function formatMetadata( $context = false ) {
@@ -1963,7 +1963,7 @@ 
 	 * Returns the number of pages of a multipage document, or false for
 	 * documents which aren't multipage documents
 	 *
-	 * @return bool|int
+	 * @return string|boolean
 	 */
 	function pageCount() {
 		if ( !isset( $this->pageCount ) ) {
@@ -2030,7 +2030,7 @@ 
 	/**
 	 * Get the HTML text of the description page, if available
 	 *
-	 * @param bool|Language $lang Optional language to fetch description in
+	 * @param Language $lang Optional language to fetch description in
 	 * @return string
 	 */
 	function getDescriptionText( $lang = false ) {

includes/filerepo/file/LocalFile.php

Doc Comments +5 added lines, -5 removed lines

@@ -191,7 +191,7 @@ 
 
 	/**
 	 * Fields in the image table
-	 * @return array
+	 * @return string[]
 	 */
 	static function selectFields() {
 		return [
@@ -1114,11 +1114,11 @@ 
 
 	/**
 	 * Upload a file and record it in the DB
-	 * @param string|FSFile $src Source storage path, virtual URL, or filesystem path
+	 * @param string $src Source storage path, virtual URL, or filesystem path
 	 * @param string $comment Upload description
 	 * @param string $pageText Text to use for the new description page,
 	 *   if a new description page is created
-	 * @param int|bool $flags Flags for publish()
+	 * @param integer $flags Flags for publish()
 	 * @param array|bool $props File properties, if known. This can be used to
 	 *   reduce the upload time when uploading virtual URLs for which the file
 	 *   info is already known
@@ -1815,7 +1815,7 @@ 
 	 * it skips the parser cache.
 	 *
 	 * @param Language $lang What language to get description in (Optional)
-	 * @return bool|mixed
+	 * @return false|string
 	 */
 	function getDescriptionText( $lang = null ) {
 		$revision = Revision::newFromTitle( $this->title, false, Revision::READ_NORMAL );
@@ -1859,7 +1859,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public function getDescriptionTouched() {
 		// The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo

includes/import/WikiImporter.php

Doc Comments +3 added lines

@@ -116,6 +116,9 @@
 		wfDebug( "IMPORT: $data\n" );
 	}
 
+	/**
+	 * @param string $msg
+	 */
 	public function notice( $msg /*, $param, ...*/ ) {
 		$params = func_get_args();
 		array_shift( $params );

includes/jobqueue/aggregator/JobQueueAggregatorRedis.php

Doc Comments +1 added lines, -1 removed lines

@@ -122,7 +122,7 @@
 
 	/**
 	 * @param string $name
-	 * @return string
+	 * @return string[]
 	 */
 	private function decodeQueueName( $name ) {
 		list( $type, $wiki ) = explode( '/', $name, 2 );

includes/jobqueue/JobQueueDB.php

Doc Comments +6 added lines, -6 removed lines

@@ -314,7 +314,7 @@ 
 	 * @param string $uuid 32 char hex string
 	 * @param int $rand Random unsigned integer (31 bits)
 	 * @param bool $gte Search for job_random >= $random (otherwise job_random <= $random)
-	 * @return stdClass|bool Row|false
+	 * @return Title Row|false
 	 */
 	protected function claimRandom( $uuid, $rand, $gte ) {
 		$dbw = $this->getMasterDB();
@@ -391,7 +391,7 @@ 
 	 * Reserve a row with a single UPDATE without holding row locks over RTTs...
 	 *
 	 * @param string $uuid 32 char hex string
-	 * @return stdClass|bool Row|false
+	 * @return Title Row|false
 	 */
 	protected function claimOldest( $uuid ) {
 		$dbw = $this->getMasterDB();
@@ -545,7 +545,7 @@ 
 
 	/**
 	 * @see JobQueue::getAllQueuedJobs()
-	 * @return Iterator
+	 * @return MappedIterator|null
 	 */
 	public function getAllQueuedJobs() {
 		return $this->getJobIterator( [ 'job_cmd' => $this->getType(), 'job_token' => '' ] );
@@ -553,7 +553,7 @@ 
 
 	/**
 	 * @see JobQueue::getAllAcquiredJobs()
-	 * @return Iterator
+	 * @return MappedIterator|null
 	 */
 	public function getAllAcquiredJobs() {
 		return $this->getJobIterator( [ 'job_cmd' => $this->getType(), "job_token > ''" ] );
@@ -561,7 +561,7 @@ 
 
 	/**
 	 * @param array $conds Query conditions
-	 * @return Iterator
+	 * @return MappedIterator|null
 	 */
 	protected function getJobIterator( array $conds ) {
 		$dbr = $this->getSlaveDB();
@@ -813,7 +813,7 @@ 
 	/**
 	 * Return the list of job fields that should be selected.
 	 * @since 1.23
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		return [