From 159b6b3b380807f18ed4a4ee71d3760cce450baf Mon Sep 17 00:00:00 2001
From: Umherirrender <umherirrender_de.wp@web.de>
Date: Sat, 29 Feb 2020 21:28:35 +0100
Subject: [PATCH] Improve param docs

Change-Id: I4b91b39757bb1a2717550f7c771537ee28ce0761
---
 .phpcs.xml                         | 3 ---
 includes/LoginNotify.php           | 6 +++---
 maintenance/migratePreferences.php | 2 +-
 3 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/.phpcs.xml b/.phpcs.xml
index e44849b..bea9751 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -1,9 +1,6 @@
 <?xml version="1.0"?>
 <ruleset>
 	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
-		<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
-		<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
-		<exclude name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
 		<exclude name="PSR12.Properties.ConstantVisibility.NotFound" />
 	</rule>
 
diff --git a/includes/LoginNotify.php b/includes/LoginNotify.php
index 031dc49..8a6ecde 100644
--- a/includes/LoginNotify.php
+++ b/includes/LoginNotify.php
@@ -562,7 +562,7 @@ class LoginNotify implements LoggerAwareInterface {
 	 * machines.
 	 *
 	 * @param User $user
-	 * @param $cookieRecord
+	 * @param string $cookieRecord
 	 * @return bool
 	 */
 	private function isUserRecordGivenCookie( User $user, $cookieRecord ) {
@@ -638,8 +638,8 @@ class LoginNotify implements LoggerAwareInterface {
 	/**
 	 * Get the cache key for the counter.
 	 *
-	 * @param $user User
-	 * @param $type string 'known' or 'new'
+	 * @param User $user
+	 * @param string $type 'known' or 'new'
 	 * @return string The cache key
 	 */
 	private function getKey( User $user, $type ) {
diff --git a/maintenance/migratePreferences.php b/maintenance/migratePreferences.php
index 77f125c..8b33cda 100644
--- a/maintenance/migratePreferences.php
+++ b/maintenance/migratePreferences.php
@@ -100,7 +100,7 @@ class MigratePreferences extends LoggedUpdateMaintenance {
 	 * Update one user's preferences
 	 *
 	 * @param object $userRow Row from the user table
-	 * @param array $options Associative array of preference => value
+	 * @param array &$options Associative array of preference => value
 	 * @return int Number of options updated
 	 */
 	private function updateUser( $userRow, array &$options ) {