INFRA-132 - Docblock formatting fixes

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

diff --git a/api/v3/MailingEventConfirm.php b/api/v3/MailingEventConfirm.php
index c1b64a4d7c82d9133306a469b5f61e2be0d6c1f2..9a66bb024e709326087e2143bc5bf8fc0c0d6122 100644 (file)
--- a/api/v3/MailingEventConfirm.php
+++ b/api/v3/MailingEventConfirm.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -40,11 +39,13 @@
 /**
  * Handle a confirm event
  *
- * @param array $params Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'survey'
  *
  * @throws Exception
- * @return array api result array
+ * @return array
+ *   api result array
  * {@getfields mailing_event_confirm_create}
  * @access public
  */
@@ -66,11 +67,14 @@ function civicrm_api3_mailing_event_confirm_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_mailing_event_confirm_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
+  $params['contact_id']['title'] = 'Contact ID';
   $params['subscribe_id']['api.required'] = 1;
+  $params['subscribe_id']['title'] = 'Subscribe Event ID';
   $params['hash']['api.required'] = 1;
+  $params['hash']['title'] = 'Hash';
 }
-