Add phpdoc comment to random recipients function

diff --git a/CRM/Mailing/BAO/Recipients.php b/CRM/Mailing/BAO/Recipients.php
index a4fc9e6525f9fe86c02cfb32bd52db1340e88be2..b5e11acb01c8fc224d24c24c979df15ebe5e10e5 100644 (file)
--- 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) {