wikimedia / mediawiki

includes/libs/rdbms/database/Database.php

Doc Comments +17 added lines, -4 removed lines

@@ -644,7 +644,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -756,7 +756,7 @@ 
 	}
 
 	/**
-	 * @param $sql
+	 * @param string $sql
 	 * @return string|null
 	 */
 	protected function getQueryVerb( $sql ) {
@@ -900,6 +900,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
@@ -981,6 +987,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.
@@ -1100,7 +1110,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()
 	 */
 	protected function makeSelectOptions( $options ) {
@@ -2271,6 +2281,9 @@ 
 		return $this->insert( $destTable, $rows, $fname, $insertOptions );
 	}
 
+	/**
+	 * @param string $destTable
+	 */
 	protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
 		$fname = __METHOD__,
 		$insertOptions = [], $selectOptions = []
@@ -3345,7 +3358,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/lbfactory/ILBFactory.php

Doc Comments +16 added lines, -15 removed lines

@@ -36,22 +36,8 @@ 
 	 *
 	 * Sub-classes will extend the required keys in $conf with additional parameters
 	 *
-	 * @param $conf $params Array with keys:
-	 *  - localDomain: A DatabaseDomain or domain ID string.
-	 *  - readOnlyReason : Reason the master DB is read-only if so [optional]
-	 *  - srvCache : BagOStuff object for server cache [optional]
-	 *  - memCache : BagOStuff object for cluster memory cache [optional]
-	 *  - wanCache : WANObjectCache object [optional]
-	 *  - hostname : The name of the current server [optional]
-	 *  - cliMode: Whether the execution context is a CLI script. [optional]
-	 *  - profiler : Class name or instance with profileIn()/profileOut() methods. [optional]
-	 *  - trxProfiler: TransactionProfiler instance. [optional]
-	 *  - replLogger: PSR-3 logger instance. [optional]
-	 *  - connLogger: PSR-3 logger instance. [optional]
-	 *  - queryLogger: PSR-3 logger instance. [optional]
-	 *  - perfLogger: PSR-3 logger instance. [optional]
-	 *  - errorLogger : Callback that takes an Exception and logs it. [optional]
 	 * @throws InvalidArgumentException
+	 * @return void
 	 */
 	public function __construct( array $conf );
 
@@ -59,6 +45,7 @@ 
 	 * Disables all load balancers. All connections are closed, and any attempt to
 	 * open a new connection will result in a DBAccessError.
 	 * @see ILoadBalancer::disable()
+	 * @return void
 	 */
 	public function destroy();
 
@@ -123,6 +110,7 @@ 
 	 * Prepare all tracked load balancers for shutdown
 	 * @param integer $mode One of the class SHUTDOWN_* constants
 	 * @param callable|null $workCallback Work to mask ChronologyProtector writes
+	 * @return void
 	 */
 	public function shutdown(
 		$mode = self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback = null
@@ -132,6 +120,7 @@ 
 	 * Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot
 	 *
 	 * @param string $fname Caller name
+	 * @return void
 	 */
 	public function flushReplicaSnapshots( $fname = __METHOD__ );
 
@@ -142,6 +131,7 @@ 
 	 * @param string $fname Caller name
 	 * @param array $options Options map:
 	 *   - maxWriteDuration: abort if more than this much time was spent in write queries
+	 * @return void
 	 */
 	public function commitAll( $fname = __METHOD__, array $options = [] );
 
@@ -157,6 +147,7 @@ 
 	 *
 	 * @param string $fname
 	 * @throws DBTransactionError
+	 * @return void
 	 */
 	public function beginMasterChanges( $fname = __METHOD__ );
 
@@ -166,12 +157,14 @@ 
 	 * @param array $options Options map:
 	 *   - maxWriteDuration: abort if more than this much time was spent in write queries
 	 * @throws Exception
+	 * @return void
 	 */
 	public function commitMasterChanges( $fname = __METHOD__, array $options = [] );
 
 	/**
 	 * Rollback changes on all master connections
 	 * @param string $fname Caller name
+	 * @return void
 	 */
 	public function rollbackMasterChanges( $fname = __METHOD__ );
 
@@ -216,6 +209,7 @@ 
 	 *   - timeout : Max wait time. Default: ~60 seconds
 	 *   - ifWritesSince: Only wait if writes were done since this UNIX timestamp
 	 * @throws DBReplicationWaitError If a timeout or error occured waiting on a DB cluster
+	 * @return void
 	 */
 	public function waitForReplication( array $opts = [] );
 
@@ -226,6 +220,7 @@ 
 	 *
 	 * @param string $name Callback name
 	 * @param callable|null $callback Use null to unset a callback
+	 * @return void
 	 */
 	public function setWaitForReplicationListener( $name, callable $callback = null );
 
@@ -246,6 +241,7 @@ 
 	 * @param mixed $ticket Result of getEmptyTransactionTicket()
 	 * @param array $opts Options to waitForReplication()
 	 * @throws DBReplicationWaitError
+	 * @return void
 	 */
 	public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] );
 
@@ -259,6 +255,7 @@ 
 	 * Disable the ChronologyProtector for all load balancers
 	 *
 	 * This can be called at the start of special API entry points
+	 * @return void
 	 */
 	public function disableChronologyProtection();
 
@@ -266,16 +263,19 @@ 
 	 * Set a new table prefix for the existing local domain ID for testing
 	 *
 	 * @param string $prefix
+	 * @return void
 	 */
 	public function setDomainPrefix( $prefix );
 
 	/**
 	 * Close all open database connections on all open load balancers.
+	 * @return void
 	 */
 	public function closeAll();
 
 	/**
 	 * @param string $agent Agent name for query profiling
+	 * @return void
 	 */
 	public function setAgentName( $agent );
 
@@ -295,6 +295,7 @@ 
 	 *   - IPAddress : IP address
 	 *   - UserAgent : User-Agent HTTP header
 	 *   - ChronologyProtection : cookie/header value specifying ChronologyProtector usage
+	 * @return void
 	 */
 	public function setRequestInfo( array $info );
 }

includes/htmlform/fields/HTMLDateTimeField.php

Doc Comments +3 added lines

@@ -142,6 +142,9 @@
 		}
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	protected function formatDate( $value ) {
 		switch ( $this->mType ) {
 			case 'date':

includes/widget/DateTimeInputWidget.php

Doc Comments -4 removed lines

@@ -21,10 +21,6 @@
 
 	/**
 	 * @param array $config Configuration options
-	 * @param string $config['type'] 'date', 'time', or 'datetime'
-	 * @param string $config['min'] Minimum date, time, or datetime
-	 * @param string $config['max'] Maximum date, time, or datetime
-	 * @param bool $config['clearable'] Whether to provide for blanking the value.
 	 */
 	public function __construct( array $config = [] ) {
 		// We need $this->type set before calling the parent constructor