Merge pull request #729 from splitbrain/scrutinizer

PHPdocs, unused var, etc

1 files changed, 5 insertions, 3 deletions

diff --git a/inc/subscription.php b/inc/subscription.php
index a6f3dec44..aab6de926 100644
--- a/inc/subscription.php
+++ b/inc/subscription.php
@@ -650,9 +650,11 @@ class Subscription {
      * @todo move the whole functionality into this class, trigger SUBSCRIPTION_NOTIFY_ADDRESSLIST instead,
      *       use an array for the addresses within it
      *
-     * @param array &$data Containing $id (the page id), $self (whether the author
-     *                     should be notified, $addresslist (current email address
-     *                     list)
+     * @param array &$data Containing the entries:
+     *    - $id (the page id),
+     *    - $self (whether the author should be notified,
+     *    - $addresslist (current email address list)
+     *    - $replacements (array of additional string substitutions, @KEY@ to be replaced by value)
      */
     public function notifyaddresses(&$data) {
         if(!$this->isenabled()) return;