Merge branch '4.5' into master

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

diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php
index 505a849143992637ac65e80da875bbd59438607f..bd4899699fd03240fc48c46199e5ac96ede55e9f 100644 (file)
--- a/api/v3/ActionSchedule.php
+++ b/api/v3/ActionSchedule.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -39,7 +38,8 @@
 /**
  * Get CiviCRM Action Schedule details
  * {@getfields action_schedule_create}
- *
+ * @param array $params
+ * @return array
  */
 function civicrm_api3_action_schedule_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule');
@@ -67,27 +67,27 @@ function civicrm_api3_action_schedule_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_action_schedule_create_spec(&$params) {
   $params['title']['api.required'] = TRUE;
   $params['mapping_id']['api.required'] = TRUE;
-//  $params['entity_status']['api.required'] = TRUE;
+  //  $params['entity_status']['api.required'] = TRUE;
   $params['entity_value']['api.required'] = TRUE;
 }
 
 /**
  * delete an existing action_schedule
  *
- * @param array $params array containing id of the action_schedule
- * to be deleted
+ * @param array $params
+ *   Array containing id of the action_schedule.
+ *   to be deleted
  *
- * @return array API result array
+ * @return array
+ *   API result array
  *
- * @access public
  */
 function civicrm_api3_action_schedule_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-
-