Api docblock cleanup.

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

diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php
index 6bd144b6e9b08407be91daa5f1dbf5081ecd5faa..1623a5ba85fe16bfa274e4b3d3c61962aff1b7cb 100644 (file)
--- a/api/v3/MessageTemplate.php
+++ b/api/v3/MessageTemplate.php
@@ -22,28 +22,33 @@
  | 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 message_template functions
- *
- * @package CiviCRM_SEPA
+ * This api exposes CiviCRM message_template.
  *
+ * @package CiviCRM_APIv3
  */
 
 /**
- * @access public
+ * Create message template.
+ *
+ * @param array $params
+ *
+ * @return array
+ * @throws \API_Exception
  */
 function civicrm_api3_message_template_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * 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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_message_template_create_spec(&$params) {
   $params['msg_title']['api.required'] = 1;
@@ -51,42 +56,37 @@ function _civicrm_api3_message_template_create_spec(&$params) {
   /*  $params['entity_id']['api.required'] = 1;
   $params['entity_table']['api.default'] = "civicrm_contribution_recur";
   $params['type']['api.default'] = "R";
-  */
+   */
 }
 
 /**
+ * Delete message template.
+ *
  * @param array $params
  *
- * @return boolean
- *   | error  true if successfull, error otherwise
- * {@getfields message_template_delete}
- * @access public
+ * @return bool
+ *   API result array
  */
 function civicrm_api3_message_template_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
+ * Adjust metadata for message_template get action.
+ *
  * @param array $params
  */
 function _civicrm_api3_message_template_get_spec(&$params) {
 }
 
 /**
- * Retrieve one or more message_template
- *
- * @param array input parameters
- *
- *
- * @example SepaCreditorGet.php Standard Get Example
+ * Retrieve one or more message_template.
  *
  * @param array $params
- *   An associative array of name/value pairs.
+ *   Array of name/value pairs.
  *
  * @return array
- *   api result array
- * {@getfields message_template_get}
- * @access public
+ *   API result array.
  */
 function civicrm_api3_message_template_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -94,19 +94,21 @@ function civicrm_api3_message_template_get($params) {
 
 /**
  * Sends a template.
+ *
+ * @param array $params
  */
 function civicrm_api3_message_template_send($params) {
   CRM_Core_BAO_MessageTemplates::sendTemplate($params);
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
  *
  * 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_message_template_send_spec(&$params) {
   $params['messageTemplateID']['api.required'] = 1;