Merge pull request #4923 from colemanw/invoice_id

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

diff --git a/api/v3/ActivityType.php b/api/v3/ActivityType.php
index aedc172033c5cf1a5124fda47676a31b2d2e7599..52158cfa0bb8956f789a1a2a82995369ab422e00 100644 (file)
--- a/api/v3/ActivityType.php
+++ b/api/v3/ActivityType.php
@@ -38,7 +38,8 @@
 
 /**
  * @deprecated api notice
- * @return string to indicate this entire api entity is deprecated
+ * @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.';
@@ -49,10 +50,8 @@ function _civicrm_api3_activity_type_deprecation() {
  *
  * @param array $params
  *
- * @return array $activityTypes activity types keyed by id
- * @access public
- *
- * @example ActivityTypeGet.php
+ * @return array
+ *   activity types keyed by id
  * @deprecated - use getoptions
  */
 function civicrm_api3_activity_type_get($params) {
@@ -64,12 +63,10 @@ function civicrm_api3_activity_type_get($params) {
 /**
  * create activity type (
  *
- * @param array   $params  associated array of fields
- *                 $params['option_value_id'] is required for updation of activity type
- *
- * @return array $activityType created / updated activity type
+ * @param array $params
  *
- * @access public
+ * @return array
+ *   created / updated activity type
  *
  * @deprecated - use option_value create
  */
@@ -92,7 +89,8 @@ function civicrm_api3_activity_type_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_activity_type_create_spec(&$params) {
   $params['label']['api.required'] = 1;
@@ -104,15 +102,14 @@ function _civicrm_api3_activity_type_create_spec(&$params) {
 /**
  * delete activity type
  *
- * @param array $params array including id of activity_type to delete
+ * @param array $params
+ *   Array including id of activity_type to delete.
 
- * @return array API result array
- *
- * @access public
+ * @return array
+ *   API result array
  *
  * @deprecated - we will introduce OptionValue Delete- plse consider helping with this if not done
  */
 function civicrm_api3_activity_type_delete($params) {
   return civicrm_api3_create_success(CRM_Core_BAO_OptionValue::del($params['id']), $params);
 }
-