more api comment fixes

[civicrm-core.git] / api / v3 / MailingEventQueue.php

diff --git a/api/v3/MailingEventQueue.php b/api/v3/MailingEventQueue.php
index e1aea37f7044d62cea4659246c4f2b21eb184d30..ac3bb377fe7acf66c49c00566c29d3eee17e21c9 100644 (file)
--- a/api/v3/MailingEventQueue.php
+++ b/api/v3/MailingEventQueue.php
@@ -32,19 +32,17 @@
  * @subpackage API_MailerGroup
  * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
- *
  */
+
 /**
- * Handle a confirm event
+ * Handle a confirm event.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'survey'
+ *   Array of property.
  *
  * @throws Exception
  * @return array
  *   api result array
- * {@getfields mailing_event_confirm_create}
  */
 function civicrm_api3_mailing_event_queue_create($params) {
   if (!array_key_exists('id', $params) && !array_key_exists('email_id', $params) && !array_key_exists('phone_id', $params)) {
@@ -52,14 +50,17 @@ function civicrm_api3_mailing_event_queue_create($params) {
   }
   civicrm_api3_verify_mandatory($params,
     'CRM_Mailing_DAO_MailingJob',
-    array('job_id','contact_id'),
+    array('job_id', 'contact_id'),
     FALSE
   );
   return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params);
 }
 
 /**
+ * Get mailing event queue record.
+ *
  * @param array $params
+ *
  * @return array
  */
 function civicrm_api3_mailing_event_queue_get($params) {
@@ -67,7 +68,10 @@ function civicrm_api3_mailing_event_queue_get($params) {
 }
 
 /**
+ * Delete mailing event queue record.
+ *
  * @param array $params
+ *
  * @return array
  * @throws \API_Exception
  */
@@ -76,9 +80,10 @@ function civicrm_api3_mailing_event_queue_delete($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
  *   Array or parameters determined by getfields.
  */