INFRA-132 - Batch 14 (g)
[civicrm-core.git] / api / v3 / MailingComponent.php
index 811fdefb85df4162105f3f294faf8b967db49a8f..804975114c4073e62c453f0890a40e8e66cb99bd 100644 (file)
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  * {@getfields mailing_component_create}
  * @example mailing_componentCreate.php
  *
- * @param $params
+ * @param array $params
  *
  * @throws API_Exception
- * @return array of newly created mailing_component property values.
- * @access public
+ * @return array
+ *   Array of newly created mailing_component property values.
  */
 function civicrm_api3_mailing_component_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -58,10 +57,10 @@ function civicrm_api3_mailing_component_create($params) {
  * {@getfields mailing_component_get}
  * @example mailing_componentCreate.php
  *
- * @param $params
+ * @param array $params
  *
- * @return array of retrieved mailing_component property values.
- * @access public
+ * @return array
+ *   Array of retrieved mailing_component property values.
  */
 function civicrm_api3_mailing_component_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -74,11 +73,11 @@ function civicrm_api3_mailing_component_get($params) {
  * {@getfields mailing_component_delete}
  * @example mailing_componentCreate.php
  *
- * @param $params
+ * @param array $params
  *
  * @throws API_Exception
- * @return array of deleted values.
- * @access public
+ * @return array
+ *   Array of deleted values.
  */
 function civicrm_api3_mailing_component_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);