From 0be43473212c6d1fe92a6e131d1aa50e3e56b653 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Thu, 12 Feb 2015 17:30:00 +1300 Subject: [PATCH] some comment fixes --- CRM/Contribute/BAO/Contribution.php | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index ab5a7b8d7f..fcbdacecb8 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -64,6 +64,15 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { */ public $_component = NULL; + /** + * Possibly obsolete variable. + * + * If you use it please explain why it is set in the create function here. + * + * @var string + */ + public $trxn_result_code; + /** * Class constructor. * @@ -241,9 +250,13 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { } /** - * @param array $params + * Calculate net_amount & fee_amount if they are not set. * - * @return mixed + * Net amount should be total - fee. + * This should only be called for new contributions. + * + * @param array $params + * Params for a new contribution before they are saved. */ public static function calculateMissingAmountParams(&$params) { if (!isset($params['fee_amount'])) { -- 2.25.1