--CRM-16187, fixed jenkin warnings
[civicrm-core.git] / api / v3 / FinancialType.php
index 212b15691f7fc677e93de3d0c7732d87b08bff44..7cb4b77a8bb3086f35ee1a03e3e21b85b24446aa 100644 (file)
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | 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_type functions
+ * This api exposes CiviCRM FinancialType.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_financial_type
- *
  */
 
 /**
- * Save a financial_type
- *
- * Allowed @params array keys are:
- * {@getfields financial_type_create}
- * @example financial_typeCreate.php
+ * Save a FinancialType.
  *
  * @param array $params
  *
  * @return array
- *   Array of newly created financial_type property values.
- * @access public
  */
 function civicrm_api3_financial_type_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Get a financial_type
- *
- * Allowed @params array keys are:
- * {@getfields financial_type_get}
- * @example financial_typeCreate.php
+ * Get a FinancialType.
  *
  * @param array $params
  *
  * @return array
- *   Array of retrieved financial_type property values.
- * @access public
+ *   Array of retrieved FinancialType property values.
  */
 function civicrm_api3_financial_type_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Delete a financial_type
- *
- * Allowed @params array keys are:
- * {@getfields financial_type_delete}
- * @example financial_typeCreate.php
+ * Delete a FinancialType.
  *
  * @param array $params
  *
  * @return array
  *   Array of deleted values.
- * @access public
  */
 function civicrm_api3_financial_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);