From 68a290eeaafb288452a40ca2c99cae29390cda11 Mon Sep 17 00:00:00 2001 From: Joshua Sled Date: Sun, 4 Dec 2005 16:51:35 +0000 Subject: [PATCH] Documentation. git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@12092 57a11ea4-9604-0410-9ed3-97b8803252fd --- src/register/ledger-core/gnc-ledger-display.c | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/register/ledger-core/gnc-ledger-display.c b/src/register/ledger-core/gnc-ledger-display.c index 380041b10f..52112812ea 100644 --- a/src/register/ledger-core/gnc-ledger-display.c +++ b/src/register/ledger-core/gnc-ledger-display.c @@ -461,8 +461,12 @@ gnc_ledger_display_gl (void) } /** - * id is some identifier that can be: - * FIXME: what's the correct description of 'id'? + * @param id: The string version of the GUID of the context of template + * transaction being edited in this template GL. As used by scheduled + * transactions, this is the GUID of the SX itself which is magically the + * *name* of the (template) account which contains the transactions for this + * scheduled transaction. That's right. The stringified GUID of the SX is + * the name of the SX'es template account. **/ GNCLedgerDisplay * gnc_ledger_display_template_gl (char *id) @@ -473,8 +477,10 @@ gnc_ledger_display_template_gl (char *id) SplitRegister *sr; AccountGroup *ag; Account *acct; + gboolean isTemplateModeTrue; acct = NULL; + isTemplateModeTrue = TRUE; q = xaccMallocQuery (); @@ -491,7 +497,8 @@ gnc_ledger_display_template_gl (char *id) ld = gnc_ledger_display_internal (NULL, q, LD_GL, SEARCH_LEDGER, REG_STYLE_JOURNAL, - FALSE, TRUE); /* TRUE : template mode */ + FALSE, + isTemplateModeTrue); sr = gnc_ledger_display_get_split_register (ld); if ( acct ) {