* src/engine/Transaction.h: fix the xaccTransOrder() documentation

to be more accurate with the actual implementation.


git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@9760 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Derek Atkins 2004-01-07 21:09:05 +00:00
parent 7985754dc8
commit 371c40076c
2 changed files with 16 additions and 4 deletions

View File

@ -1,3 +1,8 @@
2004-01-07 Derek Atkins <derek@ihtfp.com>
* src/engine/Transaction.h: fix the xaccTransOrder() documentation
to be more accurate with the actual implementation.
2004-01-06 Derek Atkins <derek@ihtfp.com> 2004-01-06 Derek Atkins <derek@ihtfp.com>
* src/engine/qofinstance.c: revert fix from 01-01, because it's wrong. * src/engine/qofinstance.c: revert fix from 01-01, because it's wrong.

View File

@ -280,10 +280,17 @@ gnc_numeric xaccTransGetAccountValue (const Transaction *trans,
/** /**
* The xaccTransOrder(ta,tb) method is useful for sorting. * The xaccTransOrder(ta,tb) method is useful for sorting.
* return a negative value if transaction ta is dated earlier than tb, * Orders ta and tb
* return a positive value if transaction ta is dated later than tb, * return <0 if ta sorts before tb
* then compares num and description values, using the strcmp() * return >0 if ta sorts after tb
* c-library routine, returning what strcmp would return. * return 0 if they are absolutely equal
*
* The comparrison uses the following fields, in order:
* date posted (compare as a date)
* num field (compare as an integer)
* date entered (compare as a date)
* description field (comcpare as a string using strcmp())
* GUID (compare as a guid)
* Finally, it returns zero if all of the above match. * Finally, it returns zero if all of the above match.
* Note that it does *NOT* compare its member splits. * Note that it does *NOT* compare its member splits.
*/ */