wikimedia / mediawiki

includes/db/Database.php

Doc Comments +6 added lines, -6 removed lines

@@ -184,7 +184,7 @@ 
 	 *   - false to disable debugging
 	 *   - omitted or null to do nothing
 	 *
-	 * @return bool|null Previous value of the flag
+	 * @return boolean Previous value of the flag
 	 */
 	public function debug( $debug = null ) {
 		return wfSetBit( $this->mFlags, DBO_DEBUG, $debug );
@@ -635,7 +635,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -1080,7 +1080,7 @@ 
 	 *
 	 * @param array $options Associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 * @see DatabaseBase::select()
 	 */
 	public function makeSelectOptions( $options ) {
@@ -2921,8 +2921,8 @@ 
 	 * on object's error ignore settings).
 	 *
 	 * @param string $filename File name to open
-	 * @param bool|callable $lineCallback Optional function called before reading each line
-	 * @param bool|callable $resultCallback Optional function called for each MySQL result
+	 * @param boolean $lineCallback Optional function called before reading each line
+	 * @param boolean $resultCallback Optional function called for each MySQL result
 	 * @param bool|string $fname Calling function name or false if name should be
 	 *   generated dynamically using $filename
 	 * @param bool|callable $inputCallback Optional function called for each
@@ -3235,7 +3235,7 @@ 
 	}
 
 	/**
-	 * @return string|bool Reason this DB is read-only or false if it is not
+	 * @return string|false Reason this DB is read-only or false if it is not
 	 */
 	protected function getReadOnlyReason() {
 		$reason = $this->getLBInfo( 'readOnlyReason' );

includes/db/DatabaseError.php

Doc Comments +1 added lines, -1 removed lines

@@ -328,7 +328,7 @@
 	/**
 	 * @param DatabaseBase $db
 	 * @param string $error
-	 * @param int|string $errno
+	 * @param integer $errno
 	 * @param string $sql
 	 * @param string $fname
 	 */

includes/db/DatabaseMssql.php

Doc Comments +6 added lines, -6 removed lines

@@ -369,8 +369,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.
@@ -378,7 +378,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
@@ -716,7 +716,7 @@ 
 	 * @param string $fname
 	 * @param array $insertOptions
 	 * @param array $selectOptions
-	 * @return null|ResultWrapper
+	 * @return ResultWrapper
 	 * @throws Exception
 	 */
 	public function insertSelect( $destTable, $srcTable, $varMap, $conds, $fname = __METHOD__,
@@ -860,7 +860,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
 	 */
@@ -1149,7 +1149,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/DatabasePostgres.php

Doc Comments +18 added lines, -2 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 = '" .
@@ -550,7 +558,7 @@ 
 	 * Return the result of the last call to nextSequenceValue();
 	 * This must be called after nextSequenceValue().
 	 *
-	 * @return int|null
+	 * @return integer
 	 */
 	function insertId() {
 		return $this->mInsertId;
@@ -1310,6 +1318,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
@@ -1333,6 +1345,10 @@ 
 		return $rows;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $rule
+	 */
 	function ruleExists( $table, $rule ) {
 		$exists = $this->selectField( 'pg_rules', 'rulename',
 			array(
@@ -1475,7 +1491,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/DatabaseSqlite.php

Doc Comments +4 added lines, -1 removed lines

@@ -551,7 +551,7 @@ 
 	 * Filter the options used in SELECT statements
 	 *
 	 * @param array $options
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		foreach ( $options as $k => $v ) {
@@ -1048,6 +1048,9 @@ 
 class SQLiteField implements Field {
 	private $info, $tableName;
 
+	/**
+	 * @param string $tableName
+	 */
 	function __construct( $info, $tableName ) {
 		$this->info = $info;
 		$this->tableName = $tableName;

includes/db/DatabaseUtility.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
 	/** @var string */
 	protected $mData;
 
+	/**
+	 * @param string $data
+	 */
 	function __construct( $data ) {
 		$this->mData = $data;
 	}

includes/db/DBConnRef.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function __call( $name, array $arguments ) {
 		if ( $this->conn === null ) {
 			list( $db, $groups, $wiki ) = $this->params;

includes/deferred/CdnCacheUpdate.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 	/**
 	 * Create an update object from an array of Title objects, or a TitleArray object
 	 *
-	 * @param Traversable|array $titles
+	 * @param TitleArrayFromResult|null $titles
 	 * @param string[] $urlArr
 	 * @return CdnCacheUpdate
 	 */

includes/deferred/SiteStatsUpdate.php

Doc Comments +6 added lines

@@ -38,6 +38,12 @@
 	protected $images = 0;
 
 	// @todo deprecate this constructor
+
+	/**
+	 * @param integer $views
+	 * @param integer $edits
+	 * @param integer $good
+	 */
 	function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
 		$this->edits = $edits;
 		$this->articles = $good;