jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/380328 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ic51c101917d6697ccaaccda9c3fc384d7453377b
---
M ASN1Parser.php
M includes/TorBlockHooks.php
M phpcs.xml
3 files changed, 15 insertions(+), 19 deletions(-)
Approvals:
jenkins-bot: Verified
Jforrester: Looks good to me, approved
diff --git a/ASN1Parser.php b/ASN1Parser.php
index 17cd244..32488c5 100644
--- a/ASN1Parser.php
+++ b/ASN1Parser.php
@@ -39,7 +39,7 @@
// @codingStandardsIgnoreEnd
/**
- * @param $number int
+ * @param int $number
* @return string
*/
public static function encodeLength( $number ) {
@@ -54,7 +54,7 @@
}
/**
- * @param $buffer string
+ * @param string $buffer
* @return array
* @throws ASN1Exception
*/
@@ -147,7 +147,7 @@
}
/**
- * @param $decodedArray array
+ * @param array $decodedArray
* @return array
*/
public static function prettyDecode( $decodedArray ) {
@@ -158,8 +158,8 @@
}
/**
- * @param $value string
- * @param $key string
+ * @param string &$value
+ * @param string $key
*/
protected static function prettyItem( &$value, $key ) {
switch ( $key ) {
@@ -175,8 +175,8 @@
}
/**
- * @param $tagId
- * @param $contents
+ * @param int $tagId
+ * @param string $contents
* @return string
* @throws ASN1Exception
*/
diff --git a/includes/TorBlockHooks.php b/includes/TorBlockHooks.php
index 6c777b4..9077e3a 100644
--- a/includes/TorBlockHooks.php
+++ b/includes/TorBlockHooks.php
@@ -79,8 +79,8 @@
* Check if a user is a Tor node and not whitelisted or allowed
* to bypass tor blocks.
*
- * @param Title $title Title being acted upon
- * @param User $user User performing the action
+ * @param Title &$title Title being acted upon
+ * @param User &$user User performing the action
* @param string $action Action being performed
* @param array &$result Will be filled with block status if blocked
* @return bool
@@ -147,7 +147,7 @@
* Set a variable for Extension:AbuseFilter indicating whether the
* user is operating from a tor exit node or not.
*
- * @param array $builder Array of builder values
+ * @param array &$builder Array of builder values
* @return bool
*/
public static function onAbuseFilterBuilder( array &$builder ) {
@@ -157,7 +157,7 @@
/**
* @static
- * @param $user User
+ * @param User &$user
* @return bool
*/
public static function onGetBlockedStatus( &$user ) {
@@ -260,7 +260,7 @@
/**
* If enabled, add a new tag type for recent changes made by Tor exit
nodes.
*
- * @param array $emptyTags List of defined tags (for ListDefinedTags
hook) or
+ * @param array &$emptyTags List of defined tags (for ListDefinedTags
hook) or
* list of active tags (for ChangeTagsListActive hook)
* @return bool true
*/
@@ -276,7 +276,7 @@
/**
* Creates a message with the Tor blocking status if applicable.
*
- * @param array $msg Message with the status
+ * @param array &$msg Message with the status
* @param string $ip The IP address to be checked
* @return bool true
*/
diff --git a/phpcs.xml b/phpcs.xml
index 0bc8fcc..bf67ffa 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -1,19 +1,15 @@
<?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="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.WrongCase"
/>
<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
+ <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
<exclude
name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
<exclude
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
</rule>
<file>.</file>
<arg name="extensions" value="php,php5,inc" />
- <arg name="encoding" value="utf8" />
- <exclude-pattern>vendor</exclude-pattern>
- <exclude-pattern>node_modules</exclude-pattern>
+ <arg name="encoding" value="UTF-8" />
</ruleset>
--
To view, visit https://gerrit.wikimedia.org/r/380328
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ic51c101917d6697ccaaccda9c3fc384d7453377b
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/TorBlock
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Jforrester <jforres...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
