X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMailingEventConfirm.php;h=66d354f9235b80aff765714590b9fe307c80d83d;hb=cd14f2d5aa5c1c12da92483aefa8704c3c0e8fbc;hp=6846fd56e67243ac5a64537128fda31f1f8adcc1;hpb=e7f7aef7265627c99d27b5e9cecdfe5d3e50f7de;p=civicrm-core.git

diff --git a/api/v3/MailingEventConfirm.php b/api/v3/MailingEventConfirm.php
index 6846fd56e6..66d354f923 100644
--- a/api/v3/MailingEventConfirm.php
+++ b/api/v3/MailingEventConfirm.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,29 +23,24 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * APIv3 functions for registering/processing mailing group events.
  *
  * @package CiviCRM_APIv3
- * @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'
+ * @param array $params
+ *   name/value pairs to insert in new 'survey'
  *
  * @throws Exception
- * @return array api result array
- * {@getfields mailing_event_confirm_create}
- * @access public
+ * @return array
+ *   api result array
  */
 function civicrm_api3_mailing_event_confirm_create($params) {
 
@@ -63,10 +57,12 @@ function civicrm_api3_mailing_event_confirm_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_mailing_event_confirm_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -76,4 +72,3 @@ function _civicrm_api3_mailing_event_confirm_create_spec(&$params) {
   $params['hash']['api.required'] = 1;
   $params['hash']['title'] = 'Hash';
 }
-