Merge pull request #5187 from mallezie/CRM-15982

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

diff --git a/api/v3/MailingGroup.php b/api/v3/MailingGroup.php
index 29c3acc388237d95d1d3c7a29853a853aa6f71be..5633e5876c33f7f4a05282a68970169a4709af03 100644 (file)
--- a/api/v3/MailingGroup.php
+++ b/api/v3/MailingGroup.php
@@ -26,17 +26,15 @@
  */
 
 /**
- *
  * APIv3 functions for registering/processing mailing group events.
  *
+ * @deprecated
  * @package CiviCRM_APIv3
- * @subpackage API_MailerGroup
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
  */
 
 /**
+ * Declare deprecated functions.
+ *
  * @deprecated api notice
  * @return string
  *   to indicate this entire api entity is deprecated
@@ -46,7 +44,8 @@ function _civicrm_api3_mailing_group_deprecation() {
 }
 
 /**
- * Handle an unsubscribe event
+ * Handle an unsubscribe event.
+ *
  * @deprecated
  *
  * @param array $params
@@ -58,7 +57,8 @@ function civicrm_api3_mailing_group_event_unsubscribe($params) {
 }
 
 /**
- * Handle a site-level unsubscribe event
+ * Handle a site-level unsubscribe event.
+ *
  * @deprecated
  *
  * @param array $params
@@ -71,7 +71,8 @@ function civicrm_api3_mailing_group_event_domain_unsubscribe($params) {
 }
 
 /**
- * Handle a resubscription event
+ * Handle a re-subscription event.
+ *
  * @deprecated
  *
  * @param array $params
@@ -83,7 +84,8 @@ function civicrm_api3_mailing_group_event_resubscribe($params) {
 }
 
 /**
- * Handle a subscription event
+ * Handle a subscription event.
+ *
  * @deprecated
  *
  * @param array $params
@@ -95,7 +97,10 @@ function civicrm_api3_mailing_group_event_subscribe($params) {
 }
 
 /**
+ * Create mailing group.
+ *
  * @param array $params
+ *
  * @return array
  * @throws \API_Exception
  */
@@ -104,6 +109,8 @@ function civicrm_api3_mailing_group_create($params) {
 }
 
 /**
+ * Get mailing group.
+ *
  * @param array $params
  *
  * @return array
@@ -113,7 +120,10 @@ function civicrm_api3_mailing_group_get($params) {
 }
 
 /**
+ * Delete mailing group.
+ *
  * @param array $params
+ *
  * @return array
  * @throws \API_Exception
  */
@@ -122,7 +132,10 @@ function civicrm_api3_mailing_group_delete($params) {
 }
 
 /**
+ * Get metadata for mailing group functions.
+ *
  * @param array $params
+ *
  * @return array
  */
 function civicrm_api3_mailing_group_getfields($params) {