some more comment fixes

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

diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php
index 6bd144b6e9b08407be91daa5f1dbf5081ecd5faa..a030409a19eb786c50feaca6167931e6826dde50 100644 (file)
--- a/api/v3/MessageTemplate.php
+++ b/api/v3/MessageTemplate.php
@@ -22,7 +22,7 @@
  | 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
@@ -32,16 +32,22 @@
  */
 
 /**
- * @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.
  */
@@ -51,16 +57,14 @@ 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";
-  */
+   */
 }
 
 /**
  * @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);
@@ -75,18 +79,11 @@ function _civicrm_api3_message_template_get_spec(&$params) {
 /**
  * Retrieve one or more message_template
  *
- * @param array input parameters
- *
- *
- * @example SepaCreditorGet.php Standard Get Example
- *
  * @param array $params
  *   An associative array of name/value pairs.
  *
  * @return array
  *   api result array
- * {@getfields message_template_get}
- * @access public
  */
 function civicrm_api3_message_template_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -94,13 +91,14 @@ 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.