wikimedia / mediawiki

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/db/DatabaseOracle.php

Doc Comments +13 added lines, -1 removed lines

@@ -85,6 +85,9 @@ 
 		unset( $this->db );
 	}
 
+	/**
+	 * @param integer $row
+	 */
 	public function seek( $row ) {
 		$this->cursor = min( $row, $this->nrows );
 	}
@@ -583,6 +586,9 @@ 
 		return $retVal;
 	}
 
+	/**
+	 * @param string $table
+	 */
 	private function fieldBindStatement( $table, $col, &$val, $includeCol = false ) {
 		$col_info = $this->fieldInfoMulti( $table, $col );
 		$col_type = $col_info != false ? $col_info->type() : 'CONSTANT';
@@ -824,6 +830,9 @@ 
 		return strtoupper( parent::tableName( $name, $format ) );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function tableNameInternal( $name ) {
 		$name = $this->tableName( $name );
 
@@ -1281,6 +1290,9 @@ 
 		return "'" . $this->strencode( $s ) . "'";
 	}
 
+	/**
+	 * @param string $s
+	 */
 	public function addIdentifierQuotes( $s ) {
 		if ( !$this->getFlag( DBO_DDLMODE ) ) {
 			$s = '/*Q*/' . $s;
@@ -1344,7 +1356,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[]
 	 */
 	function makeSelectOptions( $options ) {
 		$preLimitTail = $postLimitTail = '';

includes/diff/DifferenceEngine.php

Doc Comments +5 added lines, -5 removed lines

@@ -104,7 +104,7 @@ 
 	 * Constructor
 	 * @param IContextSource $context Context to use, anything else will be ignored
 	 * @param int $old Old ID we want to show and diff with.
-	 * @param string|int $new Either revision ID or 'prev' or 'next'. Default: 0.
+	 * @param integer $new Either revision ID or 'prev' or 'next'. Default: 0.
 	 * @param int $rcid Deprecated, no longer used!
 	 * @param bool $refreshCache If set, refreshes the diff cache
 	 * @param bool $unhide If set, allow viewing deleted revs
@@ -174,7 +174,7 @@ 
 	 *
 	 * @param int $id Revision ID
 	 *
-	 * @return mixed URL or false
+	 * @return string|false URL or false
 	 */
 	public function deletedLink( $id ) {
 		if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
@@ -676,7 +676,7 @@ 
 	 * @param string|bool $ntitle Header for new text or false
 	 * @param string $notice HTML between diff header and body
 	 *
-	 * @return mixed
+	 * @return false|string
 	 */
 	public function getDiff( $otitle, $ntitle, $notice = '' ) {
 		$body = $this->getDiffBody();
@@ -698,7 +698,7 @@ 
 	/**
 	 * Get the diff table body, without header
 	 *
-	 * @return mixed (string/false)
+	 * @return false|string (string/false)
 	 */
 	public function getDiffBody() {
 		$this->mCacheHit = true;
@@ -973,7 +973,7 @@ 
 	 *
 	 * @param string $text
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function localiseLineNumbers( $text ) {
 		return preg_replace_callback(

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/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/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 );