Cleanup api3 docblocks

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

diff --git a/api/v3/FinancialType.php b/api/v3/FinancialType.php
index c0cb44c7ff01d63720b677c600cc75eda41410dd..571e1c9759959cd54a07bbb219f3893e7aad9547 100644 (file)
--- a/api/v3/FinancialType.php
+++ b/api/v3/FinancialType.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,59 +23,46 @@
  | 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 financial_type.
  *
  * @package CiviCRM_APIv3
  * @subpackage API_financial_type
- *
  */
 
 /**
- * Save a financial_type
+ * Save a financial_type.
  *
- * Allowed @params array keys are:
- * {@getfields financial_type_create}
- * @example financial_typeCreate.php
+ * @param array $params
  *
- * @param $params
- *
- * @return array of newly created financial_type property values.
- * @access public
+ * @return array
+ *   Array of newly created financial_type property values.
  */
 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 financial_type.
  *
- * @param $params
+ * @param array $params
  *
- * @return array of retrieved financial_type property values.
- * @access public
+ * @return array
+ *   Array of retrieved financial_type 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 financial_type.
  *
- * @param $params
+ * @param array $params
  *
- * @return array of deleted values.
- * @access public
+ * @return array
+ *   Array of deleted values.
  */
 function civicrm_api3_financial_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);