jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/403692 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I08c943179d394db26f69d3542ca38d7bd56c8880
---
M .phpcs.xml
M BatchUserRights_body.php
2 files changed, 13 insertions(+), 10 deletions(-)
Approvals:
Umherirrender: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.phpcs.xml b/.phpcs.xml
index c2adbf9..1e83498 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -2,8 +2,7 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
+ <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="Squiz.Scope.MethodScope.Missing" />
<exclude name="Generic.Files.LineLength.TooLong" />
diff --git a/BatchUserRights_body.php b/BatchUserRights_body.php
index cadef15..8e1b784 100644
--- a/BatchUserRights_body.php
+++ b/BatchUserRights_body.php
@@ -42,7 +42,7 @@
* Manage forms to be shown according to posted data.
* Depending on the submit button used, call a form or a save function.
*
- * @param $par Mixed: string if any subpage provided, else null
+ * @param string|null $par string if any subpage provided, else null
*/
public function execute( $par ) {
global $wgBatchUserRightsGrantableGroups;
@@ -128,10 +128,9 @@
* Save user groups changes in the database.
* Data comes from the showEditUserGroupsForm() form function
*
- * @param $username String: username to apply changes to.
- * @param $addgroup Array: group names which the user should be added
to.
- * @param $reason String: reason for group change
- * @return null
+ * @param string $username username to apply changes to.
+ * @param array $addgroup group names which the user should be added to.
+ * @param string $reason reason for group change
*/
function saveUserGroups( $username, $addgroup, $reason = '' ) {
if ( $username == $this->getUser()->getName() ) {
@@ -186,6 +185,10 @@
/**
* Add a rights log entry for an action.
+ * @param User $user
+ * @param array $oldGroups
+ * @param array $newGroups
+ * @param string $reason
*/
function addLogEntry( $user, $oldGroups, $newGroups, $reason = '' ) {
$logEntry = new ManualLogEntry( 'rights', 'rights' );
@@ -205,7 +208,8 @@
* return a user (or proxy) object for manipulating it.
*
* Side effects: error output for invalid access
- * @return mixed User, UserRightsProxy, or null
+ * @param string $username
+ * @return User|UserRightsProxy|null
*/
function fetchUser( $username ) {
global $wgUserrightsInterwikiDelimiter;
@@ -382,7 +386,7 @@
}
/**
- * @param $group String: the name of the group to check
+ * @param string $group the name of the group to check
* @return bool Can we remove the group?
*/
private function canRemove( $group ) {
@@ -393,7 +397,7 @@
}
/**
- * @param $group string: the name of the group to check
+ * @param string $group the name of the group to check
* @return bool Can we add the group?
*/
private function canAdd( $group ) {
--
To view, visit https://gerrit.wikimedia.org/r/403692
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I08c943179d394db26f69d3542ca38d7bd56c8880
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/BatchUserRights
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
