CRM-15578 - Mailing.create API - Set defaults that match UX

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

diff --git a/api/v3/MailingEventSubscribe.php b/api/v3/MailingEventSubscribe.php
index 82cbf2509b8f4d44f4f41735832868b681d4aaa2..ac82084461ed59a313f481c11ffe37decb832d3a 100644 (file)
--- a/api/v3/MailingEventSubscribe.php
+++ b/api/v3/MailingEventSubscribe.php
@@ -30,23 +30,17 @@
  * APIv3 functions for registering/processing mailing group events.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_MailerGroup
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
  */
 
 /**
- * Subscribe from mailing group
+ * Subscribe from mailing group.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'survey'
+ *   Array per getfields metadata.
  *
  * @throws API_Exception
  * @return array
  *   api result array
- *   {@getfields mailing_event_subscribe_create}
  */
 function civicrm_api3_mailing_event_subscribe_create($params) {
   $email      = $params['email'];
@@ -83,7 +77,7 @@ function civicrm_api3_mailing_event_subscribe_create($params) {
  * The metadata is used for setting defaults, documentation & validation.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) {
   $params['email']['api.required'] = 1;