phpdoc params is always an array in api
[civicrm-core.git] / api / v3 / Mailing.php
index bc27bf1d91c1e4157566967cf192ead9937e188a..3c441888569a6f90bd38b3a2d110085e3afe70b0 100755 (executable)
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  *
  */
 
-/**
- * Files required for this package
- */
-
 /**
  * Handle a create event.
  *
@@ -48,7 +43,7 @@
  * @param array $ids
  *
  * @return array
  *   API Success Array
+ *   API Success Array
  */
 function civicrm_api3_mailing_create($params, $ids = array()) {
   if (CRM_Mailing_Info::workflowEnabled()) {
@@ -117,7 +112,7 @@ function _civicrm_api3_mailing_create_spec(&$params) {
  * @param array $ids
  *
  * @return array
  *   API Success Array
+ *   API Success Array
  */
 function civicrm_api3_mailing_delete($params, $ids = array()) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -242,7 +237,7 @@ function civicrm_api3_mailing_event_confirm($params) {
 /**
  * @deprecated api notice
  * @return array
  *   of deprecated actions
*   Array of deprecated actions
  */
 function _civicrm_api3_mailing_deprecation() {
   return array('event_confirm' => 'Mailing api "event_confirm" action is deprecated. Use the mailing_event_confirm api instead.');
@@ -588,6 +583,8 @@ function civicrm_api3_mailing_stats($params) {
  * Fix the reset dates on the email record based on when a mail was last delivered
  * We only consider mailings that were completed and finished in the last 3 to 7 days
  * Both the min and max days can be set via the params
+ * @param array $params
+ * @return array
  */
 function civicrm_api3_mailing_update_email_resetdate($params) {
   CRM_Mailing_Event_BAO_Delivered::updateEmailResetDate(