From 565e304965fb0bb3138a36ff397ada952fec0913 Mon Sep 17 00:00:00 2001
From: Linas Vepstas <linas@linas.org>
Date: Wed, 30 Sep 1998 08:06:10 +0000
Subject: [PATCH] fix documentation

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@1246 57a11ea4-9604-0410-9ed3-97b8803252fd
---
 src/engine/Transaction.h | 33 +++++++++++++++++++++++----------
 1 file changed, 23 insertions(+), 10 deletions(-)

diff --git a/src/engine/Transaction.h b/src/engine/Transaction.h
index 61a345582c..74e972d2d0 100644
--- a/src/engine/Transaction.h
+++ b/src/engine/Transaction.h
@@ -67,22 +67,35 @@ void          xaccInitTransaction (Transaction *);/* clears a trans struct */
 
 /* The xaccTransactionDestroy() method will remove all 
  *    of the splits from each of thier accounts, free the memory
- *    associated with them, and will then free the transaction
- *    itself.
+ *    associated with them.  This routine must be followed by either
+ *    an xaccTransCommitEdit(), in which case the transaction 
+ *    memory will be freed, or by xaccTransRollbackEdit(), in which 
+ *    case nothing at all is freed, and averything is put back into 
+ *    original order.
  */
 void          xaccTransDestroy (Transaction *);
 
-/* The xaccTransBeginEdit() ... 
- *    If the defer flag is set, then automated balancing
- *    is defered until the commit ...
+/* The xaccTransBeginEdit() method must be called before any changes
+ *    are made to a transaction or any of its componenet splits.  If 
+ *    this is not done, errors will result.  If the defer flag is set, 
+ *    then the automated re-balancing of all splits in this transaction
+ *    is defered until the xaccTransCommitEdit() call. This allows 
+ *    multiple splits to be edited, and prices fiddled with, and the whole
+ *    system sent temporarily out of balance, up until the Commit
+ *    call is made when double-entry is once again enforced.
  *
- * The xaccTransCommitEdit() routine may result in the deletion of the
- * transaction, if the transaction is "empty" (has no splits, or
- * has a single split in it whose value is non-zero.)
+ * The xaccTransCommitEdit() method should be used toindicate that 
+ *    all of the manipulations on teh transaction are complete, and
+ *    that these should be made permanent.  Note that this routine
+ *    may result in the deletion of the transaction, if the transaction 
+ *    is "empty" (has no splits, or * has a single split in it whose 
+ *    value is non-zero.)
  *
  * The xaccTransRollbackEdit() routine rejects all edits made, and 
- * sets the transaction back to where it was before the editing 
- * started. (Not yet implemented -- hack alert)
+ *    sets the transaction back to where it was before the editing 
+ *    started.  This includes restoring any deleted splits, removing
+ *    any added splits, and undoing the effects of xaccTransDestroy,
+ *    as well as restoring prices, memo's descriptions, etc.
  */
 void          xaccTransBeginEdit (Transaction *, int defer);
 void          xaccTransCommitEdit (Transaction *);