Improve param docs

Change-Id: I4b91b39757bb1a2717550f7c771537ee28ce0761
This commit is contained in:
Umherirrender 2020-02-29 21:28:35 +01:00
parent 8b0361f994
commit 159b6b3b38
3 changed files with 4 additions and 7 deletions

View file

@ -1,9 +1,6 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<ruleset> <ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"> <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" /> <exclude name="PSR12.Properties.ConstantVisibility.NotFound" />
</rule> </rule>

View file

@ -562,7 +562,7 @@ class LoginNotify implements LoggerAwareInterface {
* machines. * machines.
* *
* @param User $user * @param User $user
* @param $cookieRecord * @param string $cookieRecord
* @return bool * @return bool
*/ */
private function isUserRecordGivenCookie( User $user, $cookieRecord ) { private function isUserRecordGivenCookie( User $user, $cookieRecord ) {
@ -638,8 +638,8 @@ class LoginNotify implements LoggerAwareInterface {
/** /**
* Get the cache key for the counter. * Get the cache key for the counter.
* *
* @param $user User * @param User $user
* @param $type string 'known' or 'new' * @param string $type 'known' or 'new'
* @return string The cache key * @return string The cache key
*/ */
private function getKey( User $user, $type ) { private function getKey( User $user, $type ) {

View file

@ -100,7 +100,7 @@ class MigratePreferences extends LoggedUpdateMaintenance {
* Update one user's preferences * Update one user's preferences
* *
* @param object $userRow Row from the user table * @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 * @return int Number of options updated
*/ */
private function updateUser( $userRow, array &$options ) { private function updateUser( $userRow, array &$options ) {