CRM-16173 - WhitelistSubscriber - Filtering for API requests (entity/action/params)

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

diff --git a/api/v3/Grant.php b/api/v3/Grant.php
index 8a21f412effc425587c5392bd10b8dfba797c00d..5239cf8ad7c27215c34148eb85ee52d987c6ff6b 100644 (file)
--- a/api/v3/Grant.php
+++ b/api/v3/Grant.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,38 +26,32 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM Grant records.
+ *
+ * @note Grant component must be enabled.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Grant
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
- * create/update grant
- *
- * This API is used to create new grant or update any of the existing
- * In case of updating existing grant, id of that particular grant must
- * be in $params array.
+ * Create/update Grant.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'grant'
+ *   Array per getfields metadata.
  *
  * @return array
- *   grant array
- * {@getfields grant_create}
  */
 function civicrm_api3_grant_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Grant');
 }
 
 /**
- * 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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_grant_create_spec(&$params) {
   $params['grant_type_id']['api.required'] = 1;
@@ -65,34 +59,26 @@ function _civicrm_api3_grant_create_spec(&$params) {
 }
 
 /**
- * Returns array of grants  matching a set of one or more group properties
+ * Returns array of grants matching a set of one or more properties.
  *
  * @param array $params
- *   Array of one or more valid.
- *                       property_name=>value pairs. If $params is set
- *                       as null, all grants will be returned
+ *   Array per getfields metadata.
  *
  * @return array
  *   Array of matching grants
- * {@getfields grant_get}
  */
 function civicrm_api3_grant_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Grant');
 }
 
 /**
- * delete an existing grant
- *
- * This method is used to delete any existing grant. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete an existing Grant.
  *
  * @param array $params
- *   Array containing id of the group.
- *                       to be deleted
+ *   Id of the Grant to be deleted is required.
  *
  * @return array
  *   API Result Array
- * {@getfields grant_delete}
  */
 function civicrm_api3_grant_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);