X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMailingComponent.php;h=db953772ed44c1f112fe351f6f833bf0fb338611;hb=af3775b322b9e4f11d097067367f0ea7763f5f10;hp=91046a7a3ebc40637fa0901fddf102e3d5af953a;hpb=c6e262c51134924a9cc023dcb0613238fd1d0451;p=civicrm-core.git

diff --git a/api/v3/MailingComponent.php b/api/v3/MailingComponent.php
index 91046a7a3e..db953772ed 100644
--- a/api/v3/MailingComponent.php
+++ b/api/v3/MailingComponent.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,64 +23,47 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 mailing_component functions
+ * This api exposes CiviCRM MailingComponent.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_mailing_component
- *
  */
 
 /**
- * Save a mailing_component
- *
- * Allowed @params array keys are:
- * {@getfields mailing_component_create}
- * @example mailing_componentCreate.php
+ * Save a MailingComponent.
  *
  * @param array $params
  *
  * @throws API_Exception
  * @return array
- *   of newly created mailing_component property values.
- * @access public
+ *   API result array.
  */
 function civicrm_api3_mailing_component_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Get a mailing_component
- *
- * Allowed @params array keys are:
- * {@getfields mailing_component_get}
- * @example mailing_componentCreate.php
+ * Get a MailingComponent.
  *
  * @param array $params
  *
  * @return array
- *   of retrieved mailing_component property values.
- * @access public
+ *   API result array.
  */
 function civicrm_api3_mailing_component_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Delete a mailing_component
- *
- * Allowed @params array keys are:
- * {@getfields mailing_component_delete}
- * @example mailing_componentCreate.php
+ * Delete a MailingComponent.
  *
  * @param array $params
  *
  * @throws API_Exception
  * @return array
- *   of deleted values.
- * @access public
+ *   API result array.
  */
 function civicrm_api3_mailing_component_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);