add warning note

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@5022 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Linas Vepstas 2001-07-26 17:08:50 +00:00
parent 89eba41d20
commit 3a06c6f538

View File

@ -292,6 +292,13 @@ Timespec xaccSplitRetDateReconciledTS (Split *split);
* invoking any of them will cause other splits in the transaction
* to be modified so that the net value of the transaction is zero.
*
* IMPORTANT: The split should be parented by an account before
* any of these routines are invoked! This is because the actual
* setting of amounts/values requires SCU settings from the account.
* If these are not available, then amounts/values will be set to
* -1/0, which is an invalid value. I beleive this order dependency
* is a bug, but I'm too lazy to find, fix & test at the moment ...
*
* The xaccSplitSetAmount() (formerly xaccSplitSetShareAmount) method
* sets the amount in the account's commodity that the split
* should have.