wikimedia / mediawiki

includes/parser/ParserOptions.php

Doc Comments +29 added lines, -1 removed lines

@@ -356,6 +356,9 @@ 
 		return $this->mPreSaveTransform;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getDateFormat() {
 		$this->optionUsed( 'dateformat' );
 		if ( !isset( $this->mDateFormat ) ) {
@@ -429,6 +432,9 @@ 
 		return wfSetVar( $this->mDateFormat, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setEditSection( $x ) {
 		return wfSetVar( $this->mEditSection, $x );
 	}
@@ -445,6 +451,9 @@ 
 		return wfSetVar( $this->mTidy, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setInterfaceMessage( $x ) {
 		return wfSetVar( $this->mInterfaceMessage, $x );
 	}
@@ -453,6 +462,9 @@ 
 		return wfSetVar( $this->mTargetLanguage, $x, true );
 	}
 
+	/**
+	 * @param integer $x
+	 */
 	public function setMaxIncludeSize( $x ) {
 		return wfSetVar( $this->mMaxIncludeSize, $x );
 	}
@@ -474,11 +486,18 @@ 
 		return wfSetVar( $this->mExpensiveParserFunctionLimit, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setRemoveComments( $x ) {
 		return wfSetVar( $this->mRemoveComments, $x );
 	}
 
 	/* @since 1.24 */
+
+	/**
+	 * @param Closure $x
+	 */
 	public function setCurrentRevisionCallback( $x ) {
 		return wfSetVar( $this->mCurrentRevisionCallback, $x );
 	}
@@ -491,6 +510,9 @@ 
 		return wfSetVar( $this->mEnableLimitReport, $x );
 	}
 
+	/**
+	 * @param string|false $x
+	 */
 	public function setTimestamp( $x ) {
 		return wfSetVar( $this->mTimestamp, $x );
 	}
@@ -531,6 +553,9 @@ 
 		return wfSetVar( $this->mPreSaveTransform, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setIsPreview( $x ) {
 		return wfSetVar( $this->mIsPreview, $x );
 	}
@@ -539,6 +564,9 @@ 
 		return wfSetVar( $this->mIsSectionPreview, $x );
 	}
 
+	/**
+	 * @param boolean $x
+	 */
 	public function setIsPrintable( $x ) {
 		return wfSetVar( $this->mIsPrintable, $x );
 	}
@@ -723,7 +751,7 @@ 
 	 * Returns the full array of options that would have been used by
 	 * in 1.16.
 	 * Used to get the old parser cache entries when available.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function legacyOptions() {
 		return array(

includes/libs/rdbms/database/IDatabase.php

Doc Comments +13 added lines, -13 removed lines

@@ -255,7 +255,7 @@ 
 	 * High times could be due to scanning, updates, locking, and such
 	 *
 	 * @param string $type IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
-	 * @return float|bool Returns false if not transaction is active
+	 * @return null|IDatabase Returns false if not transaction is active
 	 * @since 1.26
 	 */
 	public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL );
@@ -429,7 +429,7 @@ 
 	 * Change the position of the cursor in a result object
 	 * @see http://www.php.net/mysql_data_seek
 	 *
-	 * @param mixed $res A SQL result
+	 * @param ResultWrapper $res A SQL result
 	 * @param int $row
 	 */
 	public function dataSeek( $res, $row );
@@ -559,7 +559,7 @@ 
 	 * @param string|array $table Table name. See IDatabase::select() for details.
 	 * @param string $var The field name to select. This must be a valid SQL
 	 *   fragment: do not use unvalidated user input.
-	 * @param string|array $cond The condition array. See IDatabase::select() for details.
+	 * @param string $cond The condition array. See IDatabase::select() for details.
 	 * @param string $fname The function name of the caller.
 	 * @param string|array $options The query options. See IDatabase::select() for details.
 	 *
@@ -577,10 +577,10 @@ 
 	 *
 	 * If no result rows are returned from the query, false is returned.
 	 *
-	 * @param string|array $table Table name. See IDatabase::select() for details.
+	 * @param string $table Table name. See IDatabase::select() for details.
 	 * @param string $var The field name to select. This must be a valid SQL
 	 *   fragment: do not use unvalidated user input.
-	 * @param string|array $cond The condition array. See IDatabase::select() for details.
+	 * @param string $cond The condition array. See IDatabase::select() for details.
 	 * @param string $fname The function name of the caller.
 	 * @param string|array $options The query options. See IDatabase::select() for details.
 	 *
@@ -597,7 +597,7 @@ 
 	 *
 	 * @param string|array $table Table name
 	 * @param string|array $vars Field names
-	 * @param string|array $conds Conditions
+	 * @param string $conds Conditions
 	 * @param string $fname Caller function name
 	 * @param array $options Query options
 	 * @param array $join_conds Join conditions
@@ -635,7 +635,7 @@ 
 	 *
 	 * Untrusted user input must not be passed to this parameter.
 	 *
-	 * @param string|array $conds
+	 * @param string $conds
 	 *
 	 * May be either a string containing a single condition, or an array of
 	 * conditions. If an array is given, the conditions constructed from each
@@ -753,7 +753,7 @@ 
 	 *
 	 * @param string|array $table Table name
 	 * @param string|array $vars Field names
-	 * @param string|array $conds Conditions
+	 * @param string $conds Conditions
 	 * @param string $fname Caller function name
 	 * @param string|array $options Query options
 	 * @param string|array $join_conds Join conditions
@@ -817,9 +817,9 @@ 
 	 *
 	 * @since 1.27 Added $join_conds parameter
 	 *
-	 * @param array|string $tables Table names
+	 * @param string $tables Table names
 	 * @param string $vars Unused
-	 * @param array|string $conds Filters on the table
+	 * @param string $conds Filters on the table
 	 * @param string $fname Function name for profiling
 	 * @param array $options Options for select
 	 * @param array $join_conds Join conditions (since 1.27)
@@ -1013,7 +1013,7 @@ 
 	 * @param string $delim Glue to bind the results together
 	 * @param string|array $table Table name
 	 * @param string $field Field name
-	 * @param string|array $conds Conditions
+	 * @param string $conds Conditions
 	 * @param string|array $join_conds Join conditions
 	 * @return string SQL text
 	 * @since 1.23
@@ -1053,7 +1053,7 @@ 
 	 * Adds quotes and backslashes.
 	 *
 	 * @param string|int|null|bool|Blob $s
-	 * @return string|int
+	 * @return string
 	 */
 	public function addQuotes( $s );
 
@@ -1572,7 +1572,7 @@ 
 	 * The result is unquoted, and needs to be passed through addQuotes()
 	 * before it can be included in raw SQL.
 	 *
-	 * @param string|int $ts
+	 * @param integer $ts
 	 *
 	 * @return string
 	 */

includes/libs/rdbms/database/Database.php

Doc Comments +18 added lines, -5 removed lines

@@ -650,7 +650,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -662,7 +662,7 @@ 
 	}
 
 	/**
-	 * @return string|bool Last PHP error for this DB (typically connection errors)
+	 * @return string|false Last PHP error for this DB (typically connection errors)
 	 */
 	protected function getLastPHPError() {
 		if ( $this->mPHPError ) {
@@ -770,7 +770,7 @@ 
 	}
 
 	/**
-	 * @param $sql
+	 * @param string $sql
 	 * @return string|null
 	 */
 	protected function getQueryVerb( $sql ) {
@@ -917,6 +917,12 @@ 
 		return $res;
 	}
 
+	/**
+	 * @param string $sql
+	 * @param string $commentedSql
+	 * @param boolean $isWrite
+	 * @param string $fname
+	 */
 	private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
 		$isMaster = !is_null( $this->getLBInfo( 'master' ) );
 		# generalizeSQL() will probably cut down the query to reasonable
@@ -998,6 +1004,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string $sql
+	 * @param boolean $priorWritesPending
+	 */
 	private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
 		# Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
 		# Dropped connections also mean that named locks are automatically released.
@@ -1117,7 +1127,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 Database::select()
 	 */
 	protected function makeSelectOptions( $options ) {
@@ -2288,6 +2298,9 @@ 
 		return $this->insert( $destTable, $rows, $fname, $insertOptions );
 	}
 
+	/**
+	 * @param string $destTable
+	 */
 	protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
 		$fname = __METHOD__,
 		$insertOptions = [], $selectOptions = []
@@ -3365,7 +3378,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/libs/rdbms/database/DatabaseSqlite.php

Doc Comments +3 added lines, -3 removed lines

@@ -144,7 +144,7 @@ 
 	 * @param string $dbName
 	 *
 	 * @throws DBConnectionError
-	 * @return PDO
+	 * @return resource|null
 	 */
 	function open( $server, $user, $pass, $dbName ) {
 		$this->close();
@@ -543,7 +543,7 @@ 
 	 * Filter the options used in SELECT statements
 	 *
 	 * @param array $options
-	 * @return array
+	 * @return string[]
 	 */
 	function makeSelectOptions( $options ) {
 		foreach ( $options as $k => $v ) {
@@ -773,7 +773,7 @@ 
 
 	/**
 	 * @param string|int|null|bool|Blob $s
-	 * @return string|int
+	 * @return string
 	 */
 	function addQuotes( $s ) {
 		if ( $s instanceof Blob ) {