IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix some notes

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@8122 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Linas Vepstas 2003-03-30 05:44:12 +00:00
parent 7c5f5fcaf3
commit eb0b60038c
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/engine/Transaction.h
View File

@ -552,9 +552,7 @@ void xaccSplitSetBaseValue (Split *split, gnc_numeric value,
* return the amount. If it is neither and the force_double_entry flag * 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 false, return the value. If is is neither and force_double_entry
* is true, print a warning message and return gnc_numeric_zero(). * 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, gnc_numeric xaccSplitGetBaseValue (const Split *split,
const gnc_commodity * base_currency); 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 * with non-unit share prices, it is correctly adjusted for
* share prices. * share prices.
* *
* The following three subroutines return the running balance up to & * Returns the running balance up to & including the indicated split.
* including the indicated split. (The function
* xaccSplitGetShareBalance seems to have silently disappeared.)
*/ */
gnc_numeric xaccSplitGetBalance (const Split *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 * The cleared-balance is the currency-denominated balance
* of all transactions that have been marked as cleared or reconciled. * of all transactions that have been marked as cleared or reconciled.
* It is correctly adjusted for price fluctuations. * It is correctly adjusted for price fluctuations.
*
* Returns the running balance up to & including the indicated split.
*/ */
gnc_numeric xaccSplitGetClearedBalance (const Split *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 * Returns the reconciled-balance of this split. The
* reconciled-balance is the currency-denominated balance of all * reconciled-balance is the currency-denominated balance of all
* transactions that have been marked as reconciled. * transactions that have been marked as reconciled.
*
* Returns the running balance up to & including the indicated split.
*/ */
gnc_numeric xaccSplitGetReconciledBalance (const Split *split); gnc_numeric xaccSplitGetReconciledBalance (const Split *split);