[MediaWiki-commits] [Gerrit] mediawiki...GPGMail[master]: Improve some parameter docs

2018-01-19 Thread jenkins-bot (Code Review) 
jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/403737 )

Change subject: Improve some parameter docs
..


Improve some parameter docs

Change-Id: I680630cff5b558037450be8e53f9a6fa660716a4
---
M .phpcs.xml
M GPGMailHooks.php
2 files changed, 12 insertions(+), 15 deletions(-)

Approvals:
  Umherirrender: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/.phpcs.xml b/.phpcs.xml
index c2c9ce3..d1b5f11 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -2,11 +2,8 @@
 


-   
-   

.

-   
-   vendor
+   
 
diff --git a/GPGMailHooks.php b/GPGMailHooks.php
index 8b7fe20..80fb27e 100644
--- a/GPGMailHooks.php
+++ b/GPGMailHooks.php
@@ -29,7 +29,7 @@
/**
 * Add GPG checkbox + key textbox to user preferences.
 * @param User $user
-* @param array $preferences
+* @param array &$preferences
 * @return bool
 */
public static function onGetPreferences( User $user, array 
&$preferences ) {
@@ -51,7 +51,7 @@
 
/**
 * Prevent bulk mailing users who requested encryption
-* @param MailAddress[] $to
+* @param MailAddress[] &$to
 * @return bool
 */
public static function onUserMailerSplitTo( &$to ) {
@@ -71,8 +71,8 @@
/**
 * @param MailAddress[] $to
 * @param MailAddress $from
-* @param string|array $body Email plaintext or an array with 'text' 
and 'html' keys
-* @param Message|string $error Error message when encryption fails
+* @param string|array &$body Email plaintext or an array with 'text' 
and 'html' keys
+* @param Message|string &$error Error message when encryption fails
 * @return bool
 */
public static function onUserMailerTransformContent( array $to, $from, 
&$body, &$error ) {
@@ -105,10 +105,10 @@
/**
 * @param MailAddress[] $to
 * @param MailAddress $from
-* @param string $subject Email subject (not MIME encoded)
-* @param array $headers Email headers
-* @param string $body Email body (MIME-encoded)
-* @param Message|string $error Error message when encryption fails
+* @param string &$subject Email subject (not MIME encoded)
+* @param array &$headers Email headers
+* @param string &$body Email body (MIME-encoded)
+* @param Message|string &$error Error message when encryption fails
 * @return bool
 */
public static function onUserMailerTransformMessage( $to, $from,
@@ -151,7 +151,7 @@
 
/**
 * Encrypts the message if the target user asked for that.
-* @param string $text Text of the message
+* @param string &$text Text of the message
 * @param User $user User to whom the message will be sent
 * @return Status Success or an error message
 */
@@ -170,8 +170,8 @@
}
 
/**
-* @param array $headers Email headers
-* @param string $body Email body (MIME-encoded)
+* @param array &$headers Email headers
+* @param string &$body Email body (MIME-encoded)
 * @param User $user User to whom the message will be sent
 * @return Status Success or an error message
 */

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

Gerrit-MessageType: merged
Gerrit-Change-Id: I680630cff5b558037450be8e53f9a6fa660716a4
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/GPGMail
Gerrit-Branch: master
Gerrit-Owner: Umherirrender 
Gerrit-Reviewer: Umherirrender 
Gerrit-Reviewer: jenkins-bot <>

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

[MediaWiki-commits] [Gerrit] mediawiki...GPGMail[master]: Improve some parameter docs

2018-01-11 Thread Umherirrender (Code Review) 
Umherirrender has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/403737 )

Change subject: Improve some parameter docs
..

Improve some parameter docs

Change-Id: I680630cff5b558037450be8e53f9a6fa660716a4
---
M .phpcs.xml
M GPGMailHooks.php
2 files changed, 12 insertions(+), 15 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/GPGMail 
refs/changes/37/403737/1

diff --git a/.phpcs.xml b/.phpcs.xml
index c2c9ce3..d1b5f11 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -2,11 +2,8 @@
 


-   
-   

.

-   
-   vendor
+   
 
diff --git a/GPGMailHooks.php b/GPGMailHooks.php
index 8b7fe20..80fb27e 100644
--- a/GPGMailHooks.php
+++ b/GPGMailHooks.php
@@ -29,7 +29,7 @@
/**
 * Add GPG checkbox + key textbox to user preferences.
 * @param User $user
-* @param array $preferences
+* @param array &$preferences
 * @return bool
 */
public static function onGetPreferences( User $user, array 
&$preferences ) {
@@ -51,7 +51,7 @@
 
/**
 * Prevent bulk mailing users who requested encryption
-* @param MailAddress[] $to
+* @param MailAddress[] &$to
 * @return bool
 */
public static function onUserMailerSplitTo( &$to ) {
@@ -71,8 +71,8 @@
/**
 * @param MailAddress[] $to
 * @param MailAddress $from
-* @param string|array $body Email plaintext or an array with 'text' 
and 'html' keys
-* @param Message|string $error Error message when encryption fails
+* @param string|array &$body Email plaintext or an array with 'text' 
and 'html' keys
+* @param Message|string &$error Error message when encryption fails
 * @return bool
 */
public static function onUserMailerTransformContent( array $to, $from, 
&$body, &$error ) {
@@ -105,10 +105,10 @@
/**
 * @param MailAddress[] $to
 * @param MailAddress $from
-* @param string $subject Email subject (not MIME encoded)
-* @param array $headers Email headers
-* @param string $body Email body (MIME-encoded)
-* @param Message|string $error Error message when encryption fails
+* @param string &$subject Email subject (not MIME encoded)
+* @param array &$headers Email headers
+* @param string &$body Email body (MIME-encoded)
+* @param Message|string &$error Error message when encryption fails
 * @return bool
 */
public static function onUserMailerTransformMessage( $to, $from,
@@ -151,7 +151,7 @@
 
/**
 * Encrypts the message if the target user asked for that.
-* @param string $text Text of the message
+* @param string &$text Text of the message
 * @param User $user User to whom the message will be sent
 * @return Status Success or an error message
 */
@@ -170,8 +170,8 @@
}
 
/**
-* @param array $headers Email headers
-* @param string $body Email body (MIME-encoded)
+* @param array &$headers Email headers
+* @param string &$body Email body (MIME-encoded)
 * @param User $user User to whom the message will be sent
 * @return Status Success or an error message
 */

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: I680630cff5b558037450be8e53f9a6fa660716a4
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/GPGMail
Gerrit-Branch: master
Gerrit-Owner: Umherirrender 

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