Merge branch 4.5 into master

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

diff --git a/api/v3/MailingEventUnsubscribe.php b/api/v3/MailingEventUnsubscribe.php
index d6cd367482a2006058704163f5bd1bbd19a9c2b4..2a0172f0ef3a2aab0a433582eb34e8fe5d11a0a7 100644 (file)
--- a/api/v3/MailingEventUnsubscribe.php
+++ b/api/v3/MailingEventUnsubscribe.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -34,18 +33,16 @@
  * @subpackage API_MailerGroup
  * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
- *
  */
 
 /**
- * Unsubscribe from mailing group
+ * Unsubscribe from mailing group.
  *
- * @param array $params  Associative array of property
- *                       name/value pairs to insert in new 'survey'
+ * @param array $params
+ *   Array per getfields metadata.
  *
- * @return array api result array
- * {@getfields mailing_event_unsubscribe_create}
- * @access public
+ * @return array
+ *   Api result array
  */
 function civicrm_api3_mailing_event_unsubscribe_create($params) {
 
@@ -69,15 +66,16 @@ function civicrm_api3_mailing_event_unsubscribe_create($params) {
     return civicrm_api3_create_success($params);
   }
 
-
   return civicrm_api3_create_error('Queue event could not be found');
 }
 
 /**
- * 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
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_mailing_event_unsubscribe_create_spec(&$params) {
   $params['job_id']['api.required'] = 1;
@@ -87,4 +85,3 @@ function _civicrm_api3_mailing_event_unsubscribe_create_spec(&$params) {
   $params['event_queue_id']['api.required'] = 1;
   $params['event_queue_id']['title'] = 'Mailing Queue ID';
 }
-