From eb0b60038c169e02a8be4a74b413b6f20bfc4dfe Mon Sep 17 00:00:00 2001 From: Linas Vepstas Date: Sun, 30 Mar 2003 05:44:12 +0000 Subject: [PATCH] fix some notes git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@8122 57a11ea4-9604-0410-9ed3-97b8803252fd --- src/engine/Transaction.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/engine/Transaction.h b/src/engine/Transaction.h index 798d249675..8cb2748f11 100644 --- a/src/engine/Transaction.h +++ b/src/engine/Transaction.h @@ -552,9 +552,7 @@ void xaccSplitSetBaseValue (Split *split, gnc_numeric value, * return the amount. If it is neither and the force_double_entry flag * is false, return the value. If is is neither and force_double_entry * is true, print a warning message and return gnc_numeric_zero(). - * - * @note FIXME: is this function deprecated, or is this function supposed to - * be used? */ + */ gnc_numeric xaccSplitGetBaseValue (const Split *split, const gnc_commodity * base_currency); @@ -563,9 +561,7 @@ gnc_numeric xaccSplitGetBaseValue (const Split *split, * with non-unit share prices, it is correctly adjusted for * share prices. * - * The following three subroutines return the running balance up to & - * including the indicated split. (The function - * xaccSplitGetShareBalance seems to have silently disappeared.) + * Returns the running balance up to & including the indicated split. */ gnc_numeric xaccSplitGetBalance (const Split *split); @@ -573,6 +569,8 @@ gnc_numeric xaccSplitGetBalance (const Split *split); * The cleared-balance is the currency-denominated balance * of all transactions that have been marked as cleared or reconciled. * It is correctly adjusted for price fluctuations. + * + * Returns the running balance up to & including the indicated split. */ gnc_numeric xaccSplitGetClearedBalance (const Split *split); @@ -580,6 +578,8 @@ gnc_numeric xaccSplitGetClearedBalance (const Split *split); * Returns the reconciled-balance of this split. The * reconciled-balance is the currency-denominated balance of all * transactions that have been marked as reconciled. + * + * Returns the running balance up to & including the indicated split. */ gnc_numeric xaccSplitGetReconciledBalance (const Split *split);