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

Doc Comments +10 added lines, -4 removed lines

@@ -376,7 +376,7 @@ 
 	/**
 	 * Get the name of the specified field in a result
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $n
 	 * @return string
 	 */
@@ -399,7 +399,7 @@ 
 	/**
 	 * Get the type of the specified field in a result
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $n
 	 * @return string
 	 */
@@ -421,7 +421,7 @@ 
 	/**
 	 * Move internal result pointer
 	 *
-	 * @param ResultWrapper|resource $res
+	 * @param resource $res
 	 * @param int $row
 	 * @return bool
 	 */
@@ -835,7 +835,7 @@ 
 	/**
 	 * Get the position of the master from SHOW SLAVE STATUS
 	 *
-	 * @return MySQLMasterPos|bool
+	 * @return DBMasterPos
 	 */
 	function getSlavePos() {
 		$res = $this->query( 'SHOW SLAVE STATUS', __METHOD__ );
@@ -1016,6 +1016,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $lockName
+	 */
 	private function makeLockName( $lockName ) {
 		// http://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
 		// Newer version enforce a 64 char length limit.
@@ -1371,6 +1374,9 @@ 
 		$is_pk, $is_unique, $is_multiple, $is_key, $type, $binary,
 		$is_numeric, $is_blob, $is_unsigned, $is_zerofill;
 
+	/**
+	 * @param stdClass $info
+	 */
 	function __construct( $info ) {
 		$this->name = $info->name;
 		$this->tablename = $info->table;

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

Doc Comments +17 added lines, -1 removed lines

@@ -168,6 +168,11 @@ 
 		}
 	}
 
+	/**
+	 * @param string $keyword
+	 * @param string $msg_ok
+	 * @param string $msg_failed
+	 */
 	protected function query( $keyword, $msg_ok, $msg_failed ) {
 		if ( $this->dbw->doQuery( $keyword . " " . $this->id ) !== false ) {
 		} else {
@@ -259,6 +264,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function hasConstraint( $name ) {
 		$sql = "SELECT 1 FROM pg_catalog.pg_constraint c, pg_catalog.pg_namespace n " .
 			"WHERE c.connamespace = n.oid AND conname = '" .
@@ -1308,6 +1316,10 @@ 
 		return $this->relationExists( $sequence, 'S', $schema );
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $trigger
+	 */
 	function triggerExists( $table, $trigger ) {
 		$q = <<<SQL
 	SELECT 1 FROM pg_class, pg_namespace, pg_trigger
@@ -1331,6 +1343,10 @@ 
 		return $rows;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $rule
+	 */
 	function ruleExists( $table, $rule ) {
 		$exists = $this->selectField( 'pg_rules', 'rulename',
 			[
@@ -1478,7 +1494,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/FileBackend.php

Doc Comments +1 added lines, -1 removed lines

@@ -192,7 +192,7 @@
 	/**
 	 * Get an explanatory message if this backend is read-only
 	 *
-	 * @return string|bool Returns false if the backend is not read-only
+	 * @return string|false Returns false if the backend is not read-only
 	 */
 	final public function getReadOnlyReason() {
 		return ( $this->readOnly != '' ) ? $this->readOnly : false;