Merge pull request #4616 from Edzelopez/CRM-15642
[civicrm-core.git] / CRM / Grant / BAO / Grant.php
index 11d673128c925dc8a12158ec6d233635da311bed..17e5362bf56088e1d3f8fa637f1fb975999cf167 100644 (file)
@@ -49,7 +49,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant {
   }
 
   /**
-   * Function to get events Summary
+   * get events Summary
    *
    * @static
    *
@@ -89,7 +89,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant {
   }
 
   /**
-   * Function to get events Summary
+   * get events Summary
    *
    * @static
    *
@@ -111,7 +111,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant {
   }
 
   /**
-   * Function to retrieve statistics for grants.
+   * retrieve statistics for grants.
    *
    * @static
    *
@@ -124,16 +124,12 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant {
   }
 
   /**
-   * 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_Grant_BAO_ManageGrant object
+   * @return CRM_Grant_BAO_ManageGrant object
    * @access public
    * @static
    */
@@ -314,10 +310,9 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant {
   /**
    * Function to delete the Contact
    *
-   * @param $id
+   * @param int $id contact id
    *
    * @return bool
-   * @internal param int $cid contact id
    *
    * @access public
    * @static
@@ -420,9 +415,7 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant {
   /**
    * Function to get grant record count for a Contact
    *
-   * @param $contactID
-   *
-   * @internal param int $contactId Contact ID
+   * @param int $contactID
    *
    * @return int count of grant records
    * @access public