Umherirrender has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/370755 )

Change subject: Improve some parameter docs
......................................................................

Improve some parameter docs

Change-Id: I90a518f784fb9f2a2f34032ae15afacefd1e1b66
---
M BounceHandlerHooks.php
M composer.json
M includes/ApiBounceHandler.php
M includes/BounceHandlerActions.php
M includes/EchoBounceHandlerPresentationModel.php
M includes/ProcessBounceEmails.php
M phpcs.xml
7 files changed, 12 insertions(+), 15 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/BounceHandler 
refs/changes/55/370755/1

diff --git a/BounceHandlerHooks.php b/BounceHandlerHooks.php
index 1ea01b6..225f373 100644
--- a/BounceHandlerHooks.php
+++ b/BounceHandlerHooks.php
@@ -23,7 +23,7 @@
         * Generating VERP address for a batch of send emails is complex. This 
feature is hence disabled
         *
         * @param MailAddress[] $recip Recipient's email array
-        * @param string $returnPath return-path address
+        * @param string &$returnPath return-path address
         * @return bool
         * @throws InvalidArgumentException
         */
@@ -40,7 +40,7 @@
         * Process a given $to address and return its VERP return path
         *
         * @param MailAddress $to
-        * @param string $returnPath return-path address
+        * @param string &$returnPath return-path address
         * @return bool true
         */
        protected static function generateVerp( MailAddress $to, &$returnPath ) 
{
@@ -114,7 +114,7 @@
        /**
         * Add BounceHandler events to Echo
         *
-        * @param array $notifications Echo notifications
+        * @param array &$notifications Echo notifications
         * @return bool
         */
        public static function onBeforeCreateEchoEvent( array &$notifications ) 
{
@@ -143,7 +143,7 @@
         * Add user to be notified on echo event
         *
         * @param EchoEvent $event
-        * @param User[] $users
+        * @param User[] &$users
         * @return bool
         */
        public static function onEchoGetDefaultNotifiedUsers( EchoEvent $event, 
array &$users ) {
diff --git a/composer.json b/composer.json
index bf202bf..fd295f4 100644
--- a/composer.json
+++ b/composer.json
@@ -7,7 +7,7 @@
        "scripts": {
                "fix": "phpcbf",
                "test": [
-                       "parallel-lint . --exclude vendor",
+                       "parallel-lint . --exclude vendor --exclude 
node_modules",
                        "phpcs -p -s"
                ]
        }
diff --git a/includes/ApiBounceHandler.php b/includes/ApiBounceHandler.php
index 2c6c323..96f254f 100644
--- a/includes/ApiBounceHandler.php
+++ b/includes/ApiBounceHandler.php
@@ -89,6 +89,7 @@
 
        /**
         * @see ApiBase::getExamplesMessages()
+        * @return array
         */
        public function getExamplesMessages() {
                return [
diff --git a/includes/BounceHandlerActions.php 
b/includes/BounceHandlerActions.php
index 26b8c2b..664a019 100644
--- a/includes/BounceHandlerActions.php
+++ b/includes/BounceHandlerActions.php
@@ -114,8 +114,8 @@
         * Function to inject Echo notification to the last source of bounce 
for an
         * unsubscribed Global user
         *
-        * @param $bounceUserId
-        * @param $originalEmail
+        * @param int $bounceUserId
+        * @param string $originalEmail
         */
        public function notifyGlobalUser( $bounceUserId, $originalEmail ) {
                $params = [
diff --git a/includes/EchoBounceHandlerPresentationModel.php 
b/includes/EchoBounceHandlerPresentationModel.php
index fc94fbd..7ca22db 100644
--- a/includes/EchoBounceHandlerPresentationModel.php
+++ b/includes/EchoBounceHandlerPresentationModel.php
@@ -2,14 +2,14 @@
 
 class EchoBounceHandlerPresentationModel extends EchoEventPresentationModel {
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getIconType() {
                return 'placeholder';
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getPrimaryLink() {
                return [
@@ -19,7 +19,7 @@
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getHeaderMessage() {
                $msg = parent::getHeaderMessage();
diff --git a/includes/ProcessBounceEmails.php b/includes/ProcessBounceEmails.php
index b9d87b7..ce06b55 100644
--- a/includes/ProcessBounceEmails.php
+++ b/includes/ProcessBounceEmails.php
@@ -228,7 +228,7 @@
        /**
         * Get a lazy connection to the bounce table
         *
-        * @param integer $index DB_MASTER/DB_SLAVE
+        * @param int $index DB_MASTER/DB_SLAVE
         * @param string $wiki The DB that the bounced email was sent from
         * @return IDatabase
         */
diff --git a/phpcs.xml b/phpcs.xml
index 79abcb0..af73563 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,10 +2,6 @@
 <ruleset>
        <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
                <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
                <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
                <exclude 
name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
                <exclude 
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />

-- 
To view, visit https://gerrit.wikimedia.org/r/370755
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I90a518f784fb9f2a2f34032ae15afacefd1e1b66
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/BounceHandler
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to