From df6641bb850e100ccbd8067c95857ae45434eed2 Mon Sep 17 00:00:00 2001 From: Linas Vepstas Date: Sun, 13 Jul 2003 03:39:14 +0000 Subject: [PATCH] improved documentation git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@8860 57a11ea4-9604-0410-9ed3-97b8803252fd --- src/engine/Group.h | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/engine/Group.h b/src/engine/Group.h index 31cfeca4f2..219e8637db 100644 --- a/src/engine/Group.h +++ b/src/engine/Group.h @@ -323,7 +323,7 @@ int xaccAccountStagedTransactionTraversal(Account *a, TransactionCallbackInt, void *data); -/* Traverse all of the transactions in the given account group. +/** Traverse all of the transactions in the given account group. Continue processing IFF proc does not return FALSE. This function will descend recursively to traverse transactions in the children of the accounts in the group. @@ -337,7 +337,17 @@ int xaccAccountStagedTransactionTraversal(Account *a, called once per account on the shared transactions. The result of this function will not be FALSE IFF every relevant - transaction was traversed exactly once. */ + transaction was traversed exactly once. + + Note that the traversal occurs only over the transactions that + are locally cached in the local gnucash engine. If the gnucash + engine is attached to a remote database, the database may contain + (many) transactions that are not mirrored in the local cache. + This routine will not cause an SQL database query to be performed; + it will not traverse transactions present only in the remote + database. + */ + gboolean xaccGroupForEachTransaction(AccountGroup *g, TransactionCallback,