Api docblock cleanup.
[civicrm-core.git] / api / v3 / ActionSchedule.php
index 946318deb43ef633cb313b589f100a7bdb9ae922..0a5083b87dba92a4de07b01139e132e6225521be 100644 (file)
  */
 
 /**
- * File for the CiviCRM APIv3 for Scheduled Reminders
+ * This api exposes CiviCRM Scheduled Reminders.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_ActionSchedule
- *
  */
 
 /**
@@ -66,7 +64,7 @@ function civicrm_api3_action_schedule_create($params) {
  * 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_action_schedule_create_spec(&$params) {
   $params['title']['api.required'] = TRUE;
@@ -78,8 +76,7 @@ function _civicrm_api3_action_schedule_create_spec(&$params) {
  * Delete an existing action_schedule.
  *
  * @param array $params
- *   Array containing id of the action_schedule.
- *   to be deleted
+ *   Array containing id of the action_schedule to be deleted.
  *
  * @return array
  *   API result array