wikimedia / mediawiki

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 boolean 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 boolean 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 [

includes/WatchedItemStore.php

Doc Comments +5 added lines

@@ -410,6 +410,11 @@
 		return true;
 	}
 
+	/**
+	 * @param WatchedItem|null $item
+	 * @param string $force
+	 * @param integer $oldid
+	 */
 	private function getNotificationTimestamp( User $user, Title $title, $item, $force, $oldid ) {
 		if ( !$oldid ) {
 			// No oldid given, assuming latest revision; clear the timestamp.

includes/filerepo/file/LocalFile.php

Doc Comments +6 added lines, -6 removed lines

@@ -187,7 +187,7 @@ 
 
 	/**
 	 * Fields in the image table
-	 * @return array
+	 * @return string[]
 	 */
 	static function selectFields() {
 		return [
@@ -1108,11 +1108,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
@@ -1799,7 +1799,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 );
@@ -1834,7 +1834,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string
 	 */
 	function getTimestamp() {
 		$this->load();
@@ -1843,7 +1843,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/filerepo/FileRepo.php

Doc Comments +5 added lines, -5 removed lines

@@ -220,7 +220,7 @@ 
 	 * Get an explanatory message if this repo is read-only.
 	 * This checks if an administrator disabled writes to the backend.
 	 *
-	 * @return string|bool Returns false if the repo is not read-only
+	 * @return string|false Returns false if the repo is not read-only
 	 */
 	public function getReadOnlyReason() {
 		return $this->backend->getReadOnlyReason();
@@ -716,7 +716,7 @@ 
 	 *
 	 * @param string $query Query string to append
 	 * @param string $entry Entry point; defaults to index
-	 * @return string|bool False on failure
+	 * @return string|false False on failure
 	 */
 	public function makeUrl( $query = '', $entry = 'index' ) {
 		if ( isset( $this->scriptDirUrl ) ) {
@@ -797,7 +797,7 @@ 
 	/**
 	 * Get the URL of the stylesheet to apply to description pages
 	 *
-	 * @return string|bool False on failure
+	 * @return string|false False on failure
 	 */
 	public function getDescriptionStylesheetUrl() {
 		if ( isset( $this->scriptDirUrl ) ) {
@@ -958,7 +958,7 @@ 
 	 *
 	 * @param string|FSFile $src Source file system path, storage path, or virtual URL
 	 * @param string $dst Virtual URL or storage path
-	 * @param array|string|null $options An array consisting of a key named headers
+	 * @param string $options An array consisting of a key named headers
 	 *   listing extra headers. If a string, taken as content-disposition header.
 	 *   (Support for array of options new in 1.23)
 	 * @return FileRepoStatus
@@ -1158,7 +1158,7 @@ 
 	 * Options to $options include:
 	 *   - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
 	 *
-	 * @param string|FSFile $src The source file system path, storage path, or URL
+	 * @param string $src The source file system path, storage path, or URL
 	 * @param string $dstRel The destination relative path
 	 * @param string $archiveRel The relative path where the existing file is to
 	 *   be archived, if there is one. Relative to the public zone root.

languages/Language.php

Doc Comments +17 added lines, -15 removed lines

@@ -738,7 +738,7 @@ 
 	}
 
 	/**
-	 * @return array|string
+	 * @return string
 	 */
 	function getDefaultDateFormat() {
 		$df = self::$dataCache->getItem( $this->mCode, 'defaultDateFormat' );
@@ -922,7 +922,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	function getMonthNamesArray() {
 		$monthNames = [ '' ];
@@ -949,7 +949,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	function getMonthAbbreviationsArray() {
 		$monthNames = [ '' ];
@@ -1011,7 +1011,7 @@ 
 	 * Pass through result from $dateTimeObj->format()
 	 * @param DateTime|bool|null &$dateTimeObj
 	 * @param string $ts
-	 * @param DateTimeZone|bool|null $zone
+	 * @param null|DateTimeZone $zone
 	 * @param string $code
 	 * @return string
 	 */
@@ -1808,7 +1808,7 @@ 
 	 *
 	 * @param int $year
 	 *
-	 * @return string
+	 * @return integer
 	 */
 	private static function hebrewYearStart( $year ) {
 		$a = intval( ( 12 * ( $year - 1 ) + 17 ) % 19 );
@@ -2596,7 +2596,7 @@ 
 
 	/**
 	 * @param array $matches
-	 * @return mixed|string
+	 * @return string
 	 */
 	function ucwordbreaksCallbackAscii( $matches ) {
 		return $this->ucfirst( $matches[1] );
@@ -2699,7 +2699,7 @@ 
 
 	/**
 	 * @param string $str
-	 * @return mixed|string
+	 * @return string
 	 */
 	function lcfirst( $str ) {
 		$o = ord( $str );
@@ -2718,7 +2718,7 @@ 
 	/**
 	 * @param string $str
 	 * @param bool $first
-	 * @return mixed|string
+	 * @return string
 	 */
 	function lc( $str, $first = false ) {
 		if ( function_exists( 'mb_strtolower' ) ) {
@@ -2755,7 +2755,7 @@ 
 
 	/**
 	 * @param string $str
-	 * @return mixed|string
+	 * @return string
 	 */
 	function ucwords( $str ) {
 		if ( $this->isMultibyte( $str ) ) {
@@ -2787,7 +2787,7 @@ 
 	 * capitalize words at word breaks
 	 *
 	 * @param string $str
-	 * @return mixed
+	 * @return string
 	 */
 	function ucwordbreaks( $str ) {
 		if ( $this->isMultibyte( $str ) ) {
@@ -2858,7 +2858,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string
 	 */
 	function fallback8bitEncoding() {
 		return self::$dataCache->getItem( $this->mCode, 'fallback8bitEncoding' );
@@ -4154,6 +4154,8 @@ 
 	 * @param Title &$nt The title object of the link
 	 * @param bool $ignoreOtherCond To disable other conditions when
 	 *   we need to transclude a template or update a category's link
+	 * @param string $link
+	 * @param Title $nt
 	 */
 	public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
 		$this->mConverter->findVariantLink( $link, $nt, $ignoreOtherCond );
@@ -4469,7 +4471,7 @@ 
 
 	/**
 	 * @param string $talk
-	 * @return mixed
+	 * @return string
 	 */
 	function fixVariableInNamespace( $talk ) {
 		if ( strpos( $talk, '$1' ) === false ) {
@@ -4545,7 +4547,7 @@ 
 
 	/**
 	 * @todo Document
-	 * @param int|float $seconds
+	 * @param double $seconds
 	 * @param array $format Optional
 	 *   If $format['avoid'] === 'avoidseconds': don't mention seconds if $seconds >= 1 hour.
 	 *   If $format['avoid'] === 'avoidminutes': don't mention seconds/minutes if $seconds > 48 hours.
@@ -4714,7 +4716,7 @@ 
 	 * @param string $details HTML safe text between brackets
 	 * @param bool $oppositedm Add the direction mark opposite to your
 	 *   language, to display text properly
-	 * @return HTML escaped string
+	 * @return string escaped string
 	 */
 	function specialList( $page, $details, $oppositedm = true ) {
 		if ( !$details ) {
@@ -4799,7 +4801,7 @@ 
 	/**
 	 * Get the conversion rule title, if any.
 	 *
-	 * @return string
+	 * @return boolean
 	 */
 	public function getConvRuleTitle() {
 		return $this->mConverter->getConvRuleTitle();

includes/api/ApiBase.php

Doc Comments +14 added lines, -10 removed lines

@@ -408,7 +408,7 @@ 
 	 * Returning true will generate errors indicating that the API module needs
 	 * updating.
 	 *
-	 * @return string|false
+	 * @return boolean
 	 */
 	public function needsToken() {
 		return false;
@@ -421,7 +421,7 @@ 
 	 *
 	 * @since 1.24
 	 * @param array $params All supplied parameters for the module
-	 * @return string|array|null
+	 * @return string
 	 */
 	protected function getWebUITokenSalt( array $params ) {
 		return null;
@@ -437,7 +437,7 @@ 
 	 *    RFC 7232 § 2.2 for semantics.
 	 *  - etag: Return an entity-tag representing the state of all resources involved
 	 *    in the request. Quotes must be included. See RFC 7232 § 2.3 for semantics.
-	 * @return string|bool|null As described above, or null if no value is available.
+	 * @return string As described above, or null if no value is available.
 	 */
 	public function getConditionalRequestData( $condition ) {
 		return null;
@@ -486,7 +486,7 @@ 
 	/**
 	 * Get the parent of this module
 	 * @since 1.25
-	 * @return ApiBase|null
+	 * @return ApiMain
 	 */
 	public function getParent() {
 		return $this->isMain() ? null : $this->getMain();
@@ -621,6 +621,7 @@ 
 	/**
 	 * Set the continuation manager
 	 * @param ApiContinuationManager|null
+	 * @param ApiContinuationManager|null $manager
 	 */
 	public function setContinuationManager( $manager ) {
 		// Main module has setContinuationManager() method overridden
@@ -704,6 +705,7 @@ 
 	 *
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which exactly one must be set
+	 * @param string $required
 	 */
 	public function requireOnlyOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -730,6 +732,7 @@ 
 	 *
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which at most one must be set
+	 * @param string $required
 	 */
 	public function requireMaxOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -753,6 +756,7 @@ 
 	 * @since 1.23
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which at least one must be set
+	 * @param string $required
 	 */
 	public function requireAtLeastOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -2531,7 +2535,7 @@ 
 	 * "apihelp-{$this->getModulePath()}-description".
 	 *
 	 * @deprecated since 1.25
-	 * @return Message|string|array
+	 * @return boolean
 	 */
 	protected function getDescription() {
 		return false;
@@ -2567,7 +2571,7 @@ 
 	 * that value, and boolean false means "no examples".
 	 *
 	 * @deprecated since 1.25, use getExamplesMessages() instead
-	 * @return bool|string|array
+	 * @return boolean
 	 */
 	protected function getExamples() {
 		return false;
@@ -2576,7 +2580,7 @@ 
 	/**
 	 * Generates help message for this module, or false if there is no description
 	 * @deprecated since 1.25
-	 * @return string|bool
+	 * @return string
 	 */
 	public function makeHelpMsg() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2686,7 +2690,7 @@ 
 	 * Generates the parameter descriptions for this module, to be displayed in the
 	 * module's help.
 	 * @deprecated since 1.25
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function makeHelpMsgParameters() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2877,7 +2881,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileTime() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2900,7 +2904,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileDBTime() {
 		wfDeprecated( __METHOD__, '1.25' );

includes/filebackend/TempFSFile.php

Doc Comments +3 added lines

@@ -34,6 +34,9 @@
 	/** @var array Map of (path => 1) for paths to delete on shutdown */
 	protected static $pathsCollect = null;
 
+	/**
+	 * @param string|false $path
+	 */
 	public function __construct( $path ) {
 		parent::__construct( $path );
 

includes/Revision.php

Doc Comments +9 added lines, -9 removed lines

@@ -423,7 +423,7 @@ 
 	/**
 	 * Return the list of revision fields that should be selected to create
 	 * a new revision.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		global $wgContentHandlerUseDB;
@@ -454,7 +454,7 @@ 
 	/**
 	 * Return the list of revision fields that should be selected to create
 	 * a new revision from an archive row.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectArchiveFields() {
 		global $wgContentHandlerUseDB;
@@ -485,7 +485,7 @@ 
 	/**
 	 * Return the list of text fields that should be selected to read the
 	 * revision text
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectTextFields() {
 		return [
@@ -496,7 +496,7 @@ 
 
 	/**
 	 * Return the list of page fields that should be selected from page table
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectPageFields() {
 		return [
@@ -511,7 +511,7 @@ 
 
 	/**
 	 * Return the list of user fields that should be selected from user table
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectUserFields() {
 		return [ 'user_name' ];
@@ -756,7 +756,7 @@ 
 	/**
 	 * Returns the base36 sha1 of the text in this revision, or null if unknown.
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function getSha1() {
 		return $this->mSha1;
@@ -838,7 +838,7 @@ 
 	/**
 	 * Fetch revision's user id without regard for the current user's permissions
 	 *
-	 * @return string
+	 * @return integer
 	 * @deprecated since 1.25, use getUser( Revision::RAW )
 	 */
 	public function getRawUser() {
@@ -1758,7 +1758,7 @@ 
 	 *
 	 * @param Title $title
 	 * @param int $id
-	 * @return string|bool False if not found
+	 * @return string|false False if not found
 	 */
 	static function getTimestampFromId( $title, $id, $flags = 0 ) {
 		$db = ( $flags & self::READ_LATEST )
@@ -1814,7 +1814,7 @@ 
 	 * @since 1.20
 	 * @deprecated since 1.24
 	 *
-	 * @param IDatabase|int $db The Database to perform the check on. May be given as a
+	 * @param integer $db The Database to perform the check on. May be given as a
 	 *        Database object or a database identifier usable with wfGetDB.
 	 * @param int $pageId The ID of the page in question
 	 * @param int $userId The ID of the user in question

includes/cache/localisation/LCStoreCDB.php

Doc Comments +5 added lines

@@ -130,6 +130,11 @@
 		}
 	}
 
+	/**
+	 * @param string $code
+	 *
+	 * @return string
+	 */
 	protected function getFileName( $code ) {
 		if ( strval( $code ) === '' || strpos( $code, '/' ) !== false ) {
 			throw new MWException( __METHOD__ . ": Invalid language \"$code\"" );