CRM-13072 - Fix typo in api getfields sequential

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

diff --git a/api/v3/ActivityType.php b/api/v3/ActivityType.php
index d1705c641a9651836723956fe4010485489e318f..30c8a85a463990188dfe77c5e06c69a7568583e7 100644 (file)
--- a/api/v3/ActivityType.php
+++ b/api/v3/ActivityType.php
@@ -26,33 +26,32 @@
  */
 
 /**
+ * The ActivityType api is deprecated. Please use the OptionValue api instead.
+ *
  * @deprecated
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Activity
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id: ActivityType.php 30171 2010-10-14 09:11:27Z mover $
- *
  */
 
 /**
+ * Notification of deprecated function.
+ *
  * @deprecated api notice
  * @return string
  *   to indicate this entire api entity is deprecated
  */
 function _civicrm_api3_activity_type_deprecation() {
-  return 'The activity_type api is deprecated. Please use the option_value api instead.';
+  return 'The ActivityType api is deprecated. Please use the OptionValue api instead.';
 }
 
 /**
- * retrieve activity types
+ * Retrieve activity types.
  *
  * @param array $params
  *
  * @return array
  *   activity types keyed by id
- * @deprecated - use getoptions
+ * @deprecated - use the getoptions action instead
  */
 function civicrm_api3_activity_type_get($params) {
 
@@ -61,14 +60,14 @@ function civicrm_api3_activity_type_get($params) {
 }
 
 /**
- * create activity type (
+ * Create activity type.
  *
  * @param array $params
  *
  * @return array
  *   created / updated activity type
  *
- * @deprecated - use option_value create
+ * @deprecated use the OptionValue api instead
  */
 function civicrm_api3_activity_type_create($params) {
 
@@ -91,7 +90,7 @@ function civicrm_api3_activity_type_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_activity_type_create_spec(&$params) {
   $params['label']['api.required'] = 1;
@@ -101,15 +100,15 @@ function _civicrm_api3_activity_type_create_spec(&$params) {
 }
 
 /**
- * delete activity type
+ * Delete ActivityType.
  *
  * @param array $params
  *   Array including id of activity_type to delete.
-
+ *
  * @return array
  *   API result array
  *
- * @deprecated - we will introduce OptionValue Delete- plse consider helping with this if not done
+ * @deprecated use OptionValue api
  */
 function civicrm_api3_activity_type_delete($params) {
   return civicrm_api3_create_success(CRM_Core_BAO_OptionValue::del($params['id']), $params);