wikimedia / mediawiki

includes/libs/filebackend/FSFileBackend.php

Doc Comments +4 added lines

@@ -470,6 +470,10 @@
 		return $status;
 	}
 
+	/**
+	 * @param string $fullCont
+	 * @param string $dirRel
+	 */
 	protected function doSecureInternal( $fullCont, $dirRel, array $params ) {
 		$status = Status::newGood();
 		list( , $shortCont, ) = FileBackend::splitStoragePath( $params['dir'] );

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/pager/IndexPager.php

Doc Comments +1 added lines, -1 removed lines

@@ -182,7 +182,7 @@
 	/**
 	 * Get the Database object in use
 	 *
-	 * @return IDatabase
+	 * @return DatabaseBase|null
 	 */
 	public function getDatabase() {
 		return $this->mDb;

includes/resourceloader/ResourceLoaderWikiModule.php

Doc Comments +3 added lines, -3 removed lines

@@ -136,14 +136,14 @@ 
 	 * NOTE: This ONLY works for getTitleInfo() and isKnownEmpty(), NOT FOR ANYTHING ELSE.
 	 * In particular, it doesn't work for getContent() or getScript() etc.
 	 *
-	 * @return IDatabase|null
+	 * @return DatabaseBase|null
 	 */
 	protected function getDB() {
 		return wfGetDB( DB_REPLICA );
 	}
 
 	/**
-	 * @param string $title
+	 * @param string $titleText
 	 * @return null|string
 	 */
 	protected function getContent( $titleText ) {
@@ -332,7 +332,7 @@ 
 	 * @since 1.28
 	 * @param ResourceLoaderContext $context
 	 * @param IDatabase $db
-	 * @param string[] $modules
+	 * @param string[] $moduleNames
 	 */
 	public static function preloadTitleInfo(
 		ResourceLoaderContext $context, IDatabase $db, array $moduleNames

includes/Revision.php

Doc Comments +8 added lines, -8 removed lines

@@ -436,7 +436,7 @@ 
 	/**
 	 * Return the list of revision fields that should be selected to create
 	 * a new revision.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		global $wgContentHandlerUseDB;
@@ -467,7 +467,7 @@ 
 	/**
 	 * Return the list of revision fields that should be selected to create
 	 * a new revision from an archive row.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectArchiveFields() {
 		global $wgContentHandlerUseDB;
@@ -498,7 +498,7 @@ 
 	/**
 	 * Return the list of text fields that should be selected to read the
 	 * revision text
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectTextFields() {
 		return [
@@ -509,7 +509,7 @@ 
 
 	/**
 	 * Return the list of page fields that should be selected from page table
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectPageFields() {
 		return [
@@ -524,7 +524,7 @@ 
 
 	/**
 	 * Return the list of user fields that should be selected from user table
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectUserFields() {
 		return [ 'user_name' ];
@@ -872,7 +872,7 @@ 
 	/**
 	 * Fetch revision's user id without regard for the current user's permissions
 	 *
-	 * @return string
+	 * @return integer
 	 * @deprecated since 1.25, use getUser( Revision::RAW )
 	 */
 	public function getRawUser() {
@@ -1795,7 +1795,7 @@ 
 	 *
 	 * @param Title $title
 	 * @param int $id
-	 * @return string|bool False if not found
+	 * @return string|false False if not found
 	 */
 	static function getTimestampFromId( $title, $id, $flags = 0 ) {
 		$db = ( $flags & self::READ_LATEST )
@@ -1894,7 +1894,7 @@ 
 	 * @param IDatabase $db
 	 * @param int $pageId Page ID
 	 * @param int $revId Known current revision of this page
-	 * @return Revision|bool Returns false if missing
+	 * @return Revision Returns false if missing
 	 * @since 1.28
 	 */
 	public static function newKnownCurrent( IDatabase $db, $pageId, $revId ) {

includes/revisiondelete/RevisionDeleteUser.php

Doc Comments +11 added lines

@@ -126,16 +126,27 @@
 		return true;
 	}
 
+	/**
+	 * @param string $field
+	 * @param string $op
+	 * @param null|IDatabase $dbw
+	 */
 	private static function buildSetBitDeletedField( $field, $op, $value, $dbw ) {
 		return $field . ' = ' . ( $op === '&'
 			? $dbw->bitAnd( $field, $value )
 			: $dbw->bitOr( $field, $value ) );
 	}
 
+	/**
+	 * @param integer $userId
+	 */
 	public static function suppressUserName( $name, $userId, $dbw = null ) {
 		return self::setUsernameBitfields( $name, $userId, '|', $dbw );
 	}
 
+	/**
+	 * @param integer|null $userId
+	 */
 	public static function unsuppressUserName( $name, $userId, $dbw = null ) {
 		return self::setUsernameBitfields( $name, $userId, '&', $dbw );
 	}

includes/SiteStats.php

Doc Comments +1 added lines, -1 removed lines

@@ -371,7 +371,7 @@
 	 * Do all updates and commit them. More or less a replacement
 	 * for the original initStats, but without output.
 	 *
-	 * @param IDatabase|bool $database
+	 * @param DatabaseBase|null $database
 	 * - boolean: Whether to use the master DB
 	 * - IDatabase: Database connection to use
 	 * @param array $options Array of options, may contain the following values

includes/specialpage/ChangesListSpecialPage.php

Doc Comments +2 added lines, -2 removed lines

@@ -107,7 +107,7 @@ 
 	/**
 	 * Create a FormOptions object with options as specified by the user
 	 *
-	 * @param array $parameters
+	 * @param string $parameters
 	 *
 	 * @return FormOptions
 	 */
@@ -337,7 +337,7 @@ 
 	/**
 	 * Return a IDatabase object for reading
 	 *
-	 * @return IDatabase
+	 * @return DatabaseBase|null
 	 */
 	protected function getDB() {
 		return wfGetDB( DB_REPLICA );