jenkins-bot has submitted this change and it was merged.
Change subject: Consistently document function parameter $group
......................................................................
Consistently document function parameter $group
Followup to 0c174aec.
Change-Id: Idbe7eee4288b5c09d3b9f373cb4eb22da659fc16
---
M AbuseFilter.class.php
1 file changed, 8 insertions(+), 8 deletions(-)
Approvals:
Hoo man: Looks good to me, approved
jenkins-bot: Verified
diff --git a/AbuseFilter.class.php b/AbuseFilter.class.php
index bb94e6d..3e45b0a 100644
--- a/AbuseFilter.class.php
+++ b/AbuseFilter.class.php
@@ -429,7 +429,7 @@
* Returns an associative array of filters which were tripped
*
* @param $vars array
- * @param $group string The filter group to check against.
+ * @param string $group The filter's group (as defined in
$wgAbuseFilterValidGroups)
*
* @return array
*/
@@ -848,7 +848,7 @@
/**
* @param $vars AbuseFilterVariableHolder
* @param $title Title
- * @param $group string
+ * @param string $group The filter's group (as defined in
$wgAbuseFilterValidGroups)
* @return Status
*/
public static function filterAction( $vars, $title, $group = 'default'
) {
@@ -930,7 +930,7 @@
* @param $log_template
* @param $action
* @param $vars AbuseFilterVariableHolder
- * @param string $group
+ * @param string $group The filter's group (as defined in
$wgAbuseFilterValidGroups)
* @return mixed
*/
public static function addLogEntries( $actions_taken, $log_template,
$action, $vars, $group = 'default' ) {
@@ -1537,7 +1537,7 @@
}
/**
- * @param $group
+ * @param string $group The filter's group (as defined in
$wgAbuseFilterValidGroups)
* @return String
*/
public static function getGlobalRulesKey( $group ) {
@@ -1566,7 +1566,7 @@
/**
* Update statistics, and disable filters which are over-blocking.
* @param $filters
- * @param $group
+ * @param string $group The filter's group (as defined in
$wgAbuseFilterValidGroups)
*/
public static function recordStats( $filters, $group = 'default' ) {
global $wgAbuseFilterConditionLimit, $wgMemc;
@@ -1607,7 +1607,7 @@
}
/**
- * @param $group
+ * @param string $group The filter's group (as defined in
$wgAbuseFilterValidGroups)
* @param $filters
* @param $total
*/
@@ -1658,7 +1658,7 @@
/**
* @param array $emergencyValue
- * @param string $group
+ * @param string $group The filter's group (as defined in
$wgAbuseFilterValidGroups)
* @return mixed
*/
public static function getEmergencyValue( array $emergencyValue, $group
) {
@@ -2244,7 +2244,7 @@
/**
* Gives either the user-specified name for a group,
* or spits the input back out
- * @param $group String: Internal name of the filter group
+ * @param string $group The filter's group (as defined in
$wgAbuseFilterValidGroups)
* @return String A name for that filter group, or the input.
*/
static function nameGroup($group) {
--
To view, visit https://gerrit.wikimedia.org/r/171820
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Idbe7eee4288b5c09d3b9f373cb4eb22da659fc16
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/AbuseFilter
Gerrit-Branch: master
Gerrit-Owner: Nemo bis <federicol...@tiscali.it>
Gerrit-Reviewer: Hoo man <h...@online.de>
Gerrit-Reviewer: Jackmcbarn <jackmcb...@gmail.com>
Gerrit-Reviewer: Matthias Mullie <mmul...@wikimedia.org>
Gerrit-Reviewer: Se4598 <se4...@gmx.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
