Merge pull request #6363 from civicrm/CRM-16944

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

diff --git a/api/v3/Grant.php b/api/v3/Grant.php
index 0d7520dc51bc8e2f680768645422201b1a780ed3..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,21 +26,20 @@
  */
 
 /**
- * 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.
+ * Create/update Grant.
  *
  * @param array $params
  *   Array per getfields metadata.
  *
  * @return array
- *   grant array
  */
 function civicrm_api3_grant_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Grant');
@@ -52,7 +51,7 @@ function civicrm_api3_grant_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_grant_create_spec(&$params) {
   $params['grant_type_id']['api.required'] = 1;
@@ -60,7 +59,7 @@ 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 per getfields metadata.
@@ -73,13 +72,10 @@ function civicrm_api3_grant_get($params) {
 }
 
 /**
- * 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 per getfields metadata.
+ *   Id of the Grant to be deleted is required.
  *
  * @return array
  *   API Result Array