wikimedia / mediawiki

includes/filebackend/FSFile.php

Doc Comments +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
 	/**
 	 * Get the file's last-modified timestamp
 	 *
-	 * @return string|bool TS_MW timestamp or false on failure
+	 * @return string|false TS_MW timestamp or false on failure
 	 */
 	public function getTimestamp() {
 		MediaWiki\suppressWarnings();
@@ -218,7 +218,7 @@ 
 	 * fairly neatly.
 	 *
 	 * @param bool $recache
-	 * @return bool|string False on failure
+	 * @return string|false False on failure
 	 */
 	public function getSha1Base36( $recache = false ) {
 		if ( $this->sha1Base36 !== null && !$recache ) {
@@ -270,7 +270,7 @@ 
 	 * fairly neatly.
 	 *
 	 * @param string $path
-	 * @return bool|string False on failure
+	 * @return string|false False on failure
 	 */
 	public static function getSha1Base36FromPath( $path ) {
 		$fsFile = new self( $path );

includes/filebackend/FSFileBackend.php

Doc Comments +4 added lines

@@ -470,6 +470,10 @@
 		return $status;
 	}
 
+	/**
+	 * @param string $fullCont
+	 * @param string $dirRel
+	 */
 	protected function doSecureInternal( $fullCont, $dirRel, array $params ) {
 		$status = Status::newGood();
 		list( , $shortCont, ) = FileBackend::splitStoragePath( $params['dir'] );

includes/filebackend/SwiftFileBackend.php

Doc Comments +3 added lines, -3 removed lines

@@ -1314,7 +1314,7 @@ 
 	 * (lists are truncated to 10000 item with no way to page), and is just a performance risk.
 	 *
 	 * @param string $container Resolved Swift container
-	 * @param array $readGrps List of the possible criteria for a request to have
+	 * @param string[] $readGrps List of the possible criteria for a request to have
 	 * access to read a container. Each item is one of the following formats:
 	 *   - account:user        : Grants access if the request is by the given user
 	 *   - ".r:<regex>"        : Grants access if the request is from a referrer host that
@@ -1322,7 +1322,7 @@ 
 	 *                           Setting this to '*' effectively makes a container public.
 	 *   -".rlistings:<regex>" : Grants access if the request is from a referrer host that
 	 *                           matches the expression and the request is for a listing.
-	 * @param array $writeGrps A list of the possible criteria for a request to have
+	 * @param string[] $writeGrps A list of the possible criteria for a request to have
 	 * access to write to a container. Each item is of the following format:
 	 *   - account:user       : Grants access if the request is by the given user
 	 * @return Status
@@ -1705,7 +1705,7 @@ 
 	 * @param array $creds From getAuthentication()
 	 * @param string $container
 	 * @param string $object
-	 * @return array
+	 * @return string
 	 */
 	protected function storageUrl( array $creds, $container = null, $object = null ) {
 		$parts = [ $creds['storage_url'] ];

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/ForeignAPIFile.php

Doc Comments +4 added lines, -4 removed lines

@@ -33,7 +33,7 @@ 
 	protected $repoClass = 'ForeignApiRepo';
 
 	/**
-	 * @param Title|string|bool $title
+	 * @param Title|null $title
 	 * @param ForeignApiRepo $repo
 	 * @param array $info
 	 * @param bool $exists
@@ -166,7 +166,7 @@ 
 	}
 
 	/**
-	 * @return bool|null|string
+	 * @return string|null
 	 */
 	public function getMetadata() {
 		if ( isset( $this->mInfo['metadata'] ) ) {
@@ -205,7 +205,7 @@ 
 	}
 
 	/**
-	 * @return bool|int|null
+	 * @return integer|null
 	 */
 	public function getSize() {
 		return isset( $this->mInfo['size'] ) ? intval( $this->mInfo['size'] ) : null;
@@ -268,7 +268,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	function getTimestamp() {
 		return wfTimestamp( TS_MW,

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 [