wikimedia / mediawiki

includes/actions/HistoryAction.php

Doc Comments +5 added lines, -1 removed lines

@@ -317,7 +317,7 @@ 
 	 * Borrows Recent Changes' feed generation functions for formatting;
 	 * includes a diff to the previous revision (if any).
 	 *
-	 * @param stdClass|array $row Database row
+	 * @param null|stdClass $row Database row
 	 * @return FeedItem
 	 */
 	function feedItem( $row ) {
@@ -534,6 +534,10 @@ 
 		return $s;
 	}
 
+	/**
+	 * @param string $name
+	 * @param string $msg
+	 */
 	private function getRevisionButton( $name, $msg ) {
 		$this->preventClickjacking();
 		# Note bug #20966, <button> is non-standard in IE<8

includes/exception/MWExceptionRenderer.php

Doc Comments +2 added lines, -2 removed lines

@@ -30,7 +30,7 @@ 
 	/**
 	 * @param Exception|Throwable $e Original exception
 	 * @param integer $mode MWExceptionExposer::AS_* constant
-	 * @param Exception|Throwable|null $eNew New exception from attempting to show the first
+	 * @param Exception $eNew New exception from attempting to show the first
 	 */
 	public static function output( $e, $mode, $eNew = null ) {
 		global $wgMimeType;
@@ -324,7 +324,7 @@ 
 	}
 
 	/**
-	 * @param Exception|Throwable $e
+	 * @param DBConnectionError $e
 	 */
 	private static function reportOutageHTML( $e ) {
 		global $wgShowDBErrorBacktrace, $wgShowHostnames, $wgShowSQLErrors;

includes/libs/rdbms/database/DatabaseMysqlBase.php

Doc Comments +4 added lines, -1 removed lines

@@ -816,7 +816,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__ );
@@ -1012,6 +1012,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.

includes/libs/rdbms/database/resultwrapper/ResultWrapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -122,7 +122,7 @@
 	}
 
 	/**
-	 * @return stdClass|array|bool
+	 * @return null|stdClass
 	 */
 	function current() {
 		if ( is_null( $this->currentRow ) ) {

includes/libs/rdbms/database/DatabasePostgres.php

Doc Comments +12 added lines, -1 removed lines

@@ -59,6 +59,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @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 = '" .
@@ -1109,6 +1112,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
@@ -1132,6 +1139,10 @@ 
 		return $rows;
 	}
 
+	/**
+	 * @param string $table
+	 * @param string $rule
+	 */
 	function ruleExists( $table, $rule ) {
 		$exists = $this->selectField( 'pg_rules', 'rulename',
 			[
@@ -1279,7 +1290,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/libs/rdbms/lbfactory/LBFactory.php

Doc Comments -15 removed lines

@@ -84,21 +84,6 @@
 	 *
 	 * 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
 	 */
 	public function __construct( array $conf ) {

includes/Title.php

Doc Comments +12 added lines, -13 removed lines

@@ -365,7 +365,7 @@ 
 	 * objects or LinkCache entries. Uses $wgContentHandlerUseDB to determine
 	 * whether to include page_content_model.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	protected static function getSelectFields() {
 		global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
@@ -558,7 +558,7 @@ 
 	 * Get the prefixed DB key associated with an ID
 	 *
 	 * @param int $id The page_id of the article
-	 * @return Title|null An object representing the article, or null if no such article was found
+	 * @return null|string An object representing the article, or null if no such article was found
 	 */
 	public static function nameOf( $id ) {
 		$dbr = wfGetDB( DB_REPLICA );
@@ -1079,7 +1079,6 @@ 
 	/**
 	 * Returns true if the title is inside one of the specified namespaces.
 	 *
-	 * @param int|int[] $namespaces,... The namespaces to check for
 	 * @return bool
 	 * @since 1.19
 	 */
@@ -1889,7 +1888,7 @@ 
 	 *   - quick  : does cheap permission checks from replica DBs (usable for GUI creation)
 	 *   - full   : does cheap and expensive checks possibly from a replica DB
 	 *   - secure : does cheap and expensive checks, using the master as needed
-	 * @param array $ignoreErrors Array of Strings Set this to a list of message keys
+	 * @param string[] $ignoreErrors Array of Strings Set this to a list of message keys
 	 *   whose corresponding errors may be ignored.
 	 * @return array Array of arrays of the arguments to wfMessage to explain permissions problems.
 	 */
@@ -1990,7 +1989,7 @@ 
 	 * Add the resulting error code to the errors array
 	 *
 	 * @param array $errors List of current errors
-	 * @param array $result Result of errors
+	 * @param string $result Result of errors
 	 *
 	 * @return array List of errors
 	 */
@@ -2385,7 +2384,7 @@ 
 	 *
 	 * @param string $action The action to check
 	 * @param bool $short Short circuit on first error
-	 * @return array List of errors
+	 * @return string[] List of errors
 	 */
 	private function missingPermissionError( $action, $short ) {
 		// We avoid expensive display logic for quickUserCan's and such
@@ -3925,7 +3924,7 @@ 
 	 *
 	 * @param int $revId Revision ID. Get the revision that was before this one.
 	 * @param int $flags Title::GAID_FOR_UPDATE
-	 * @return int|bool Old revision ID, or false if none exists
+	 * @return integer Old revision ID, or false if none exists
 	 */
 	public function getPreviousRevisionID( $revId, $flags = 0 ) {
 		$db = ( $flags & self::GAID_FOR_UPDATE ) ? wfGetDB( DB_MASTER ) : wfGetDB( DB_REPLICA );
@@ -4065,8 +4064,8 @@ 
 	 * Get the number of revisions between the given revision.
 	 * Used for diffs and other things that really need it.
 	 *
-	 * @param int|Revision $old Old revision or rev ID (first before range)
-	 * @param int|Revision $new New revision or rev ID (first after range)
+	 * @param Revision $old Old revision or rev ID (first before range)
+	 * @param Revision $new New revision or rev ID (first after range)
 	 * @param int|null $max Limit of Revisions to count, will be incremented to detect truncations
 	 * @return int Number of revisions between these revisions.
 	 */
@@ -4178,9 +4177,9 @@ 
 	 * Used for diffs and other things that really need it.
 	 *
 	 * @param int|Revision $old Old revision or rev ID (first before range by default)
-	 * @param int|Revision $new New revision or rev ID (first after range by default)
+	 * @param Revision $new New revision or rev ID (first after range by default)
 	 * @param int $limit Maximum number of authors
-	 * @param string|array $options (Optional): Single option, or an array of options:
+	 * @param string $options (Optional): Single option, or an array of options:
 	 *     'include_old' Include $old in the range; $new is excluded.
 	 *     'include_new' Include $new in the range; $old is excluded.
 	 *     'include_both' Include both $old and $new in the range.
@@ -4336,7 +4335,7 @@ 
 	/**
 	 * Get the default message text or false if the message doesn't exist
 	 *
-	 * @return string|bool
+	 * @return false|string
 	 */
 	public function getDefaultMessageText() {
 		global $wgContLang;
@@ -4784,7 +4783,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	public function __sleep() {
 		return [

maintenance/sql.php

Doc Comments +3 added lines

@@ -143,6 +143,9 @@
 		wfWaitForSlaves();
 	}
 
+	/**
+	 * @param boolean $dieOnError
+	 */
 	protected function sqlDoQuery( IDatabase $db, $line, $dieOnError ) {
 		try {
 			$res = $db->query( $line );