Cleanup phpdoc comments

[civicrm-core.git] / CRM / Financial / BAO / FinancialAccount.php

diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php
index 2f2b05d514c6058a225488653c511d0d69e44b34..70aa0596169f830616a8988c8cc05357b158dc70 100644 (file)
--- a/CRM/Financial/BAO/FinancialAccount.php
+++ b/CRM/Financial/BAO/FinancialAccount.php
@@ -37,28 +37,24 @@
 class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAccount {
 
   /**
-   * static holder for the default LT
+   * Static holder for the default LT
    */
   static $_defaultContributionType = NULL;
 
   /**
-   * class constructor
+   * Class constructor
    */
   function __construct() {
     parent::__construct();
   }
 
   /**
-   * Takes a bunch of params that are needed to match certain criteria and
-   * retrieves the relevant objects. Typically the valid params are only
-   * contact_id. We'll tweak this function to be more full featured over a period
-   * of time. This is the inverse function of create. It also stores all the retrieved
-   * values in the default array
+   * Fetch object based on array of properties
    *
    * @param array $params   (reference ) an assoc array of name/value pairs
    * @param array $defaults (reference ) an assoc array to hold the flattened values
    *
-   * @return object CRM_Contribute_BAO_FinancialAccount object
+   * @return CRM_Contribute_BAO_FinancialAccount object
    * @access public
    * @static
    */
@@ -73,7 +69,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
   }
 
   /**
-   * update the is_active flag in the db
+   * Update the is_active flag in the db
    *
    * @param int      $id        id of the database record
    * @param boolean  $is_active value we want to set the is_active field
@@ -86,7 +82,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
   }
 
   /**
-   * function to add the financial types
+   * Add the financial types
    *
    * @param array $params reference array contains the values submitted by the form
    * @param array $ids    reference array contains the id
@@ -120,7 +116,7 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
   }
 
   /**
-   * Function to delete financial Types
+   * Delete financial Types
    *
    * @param int $financialAccountId
    * @static
@@ -156,11 +152,11 @@ class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAcco
   }
 
   /**
-   * get accounting code for a financial type with account relation Income Account is
+   * Get accounting code for a financial type with account relation Income Account is
    *
    * @financialTypeId int      Financial Type Id
    *
-   * @param $financialTypeId
+   * @param int $financialTypeId
    *
    * @return accounting code
    * @static
@@ -181,7 +177,7 @@ WHERE cft.id = %1
   }
 
   /**
-   * get AR account
+   * Get AR account
    *
    * @param $financialAccountId financial account id
    *