api test for CRM-16796
[civicrm-core.git] / api / v3 / FinancialAccount.php
index 5a231c9f555216b19fe795d2677b89a8b854653d..bbee93fc47c8eb8d97dc8e2f53d5c4e03b3a1831 100644 (file)
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 financial_account functions
+ * This api exposes CiviCRM FinancialAccount.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_financial_account
- *
  */
 
 /**
- * Save a financial_account
- *
- * Allowed @params array keys are:
- * {@getfields financial_account_create}
- * @example financial_accountCreate.php
+ * Save a FinancialAccount.
  *
  * @param array $params
  *
- * @return array of newly created financial_account property values.
- * @access public
+ * @return array
  */
 function civicrm_api3_financial_account_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Get a financial_account
- *
- * Allowed @params array keys are:
- * {@getfields financial_account_get}
- * @example financial_accountCreate.php
+ * Get a FinancialAccount.
  *
  * @param array $params
  *
- * @return array of retrieved financial_account property values.
- * @access public
+ * @return array
+ *   Array of retrieved FinancialAccount property values.
  */
 function civicrm_api3_financial_account_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Delete a financial_account
- *
- * Allowed @params array keys are:
- * {@getfields financial_account_delete}
- * @example financial_accountCreate.php
+ * Delete a FinancialAccount.
  *
  * @param array $params
  *
- * @return array of deleted values.
- * @access public
+ * @return array
+ *   Array of deleted values.
  */
 function civicrm_api3_financial_account_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);