From: David Knoll <david@futurefirst.org.uk>
Date: Tue, 30 Sep 2014 22:31:18 +0000 (+0100)
Subject: Add phpdoc comment to random recipients function
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=0ae3d02b4946942052311459c9904064a1b6feed;p=civicrm-core.git

Add phpdoc comment to random recipients function
---

diff --git a/CRM/Mailing/BAO/Recipients.php b/CRM/Mailing/BAO/Recipients.php
index a4fc9e6525..b5e11acb01 100644
--- a/CRM/Mailing/BAO/Recipients.php
+++ b/CRM/Mailing/BAO/Recipients.php
@@ -85,6 +85,16 @@ WHERE  mailing_id = %1
     return CRM_Core_DAO::executeQuery($sql, $params);
   }
 
+  /**
+   * Moves a number of randomly-chosen recipients of one Mailing to another Mailing.
+   *
+   * @param int $mailingIdC
+   *   Source mailing ID
+   * @param int $newMailingID
+   *   Destination mailing ID
+   * @param int $totalLimit
+   *   Number of recipients to move
+   */
   static function updateRandomRecipients($mailingIdC, $newMailingID, $totalLimit = NULL) {
     $limitString = NULL;
     if ($totalLimit) {