[Gnucash-changes] r12092 - gnucash/trunk/src/register/ledger-core - Documentation.

[Joshua Sled]

Author: jsled
Date: 2005-12-04 11:51:35 -0500 (Sun, 04 Dec 2005)
New Revision: 12092
Trac: http://svn.gnucash.org/trac/changeset/12092

Modified:
   gnucash/trunk/src/register/ledger-core/gnc-ledger-display.c
Log:
Documentation.


Modified: gnucash/trunk/src/register/ledger-core/gnc-ledger-display.c
===================================================================
--- gnucash/trunk/src/register/ledger-core/gnc-ledger-display.c	2005-12-04 15:27:20 UTC (rev 12091)
+++ gnucash/trunk/src/register/ledger-core/gnc-ledger-display.c	2005-12-04 16:51:35 UTC (rev 12092)
@@ -461,8 +461,12 @@
 }
 
 /**
- * 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 @@
   SplitRegister *sr;
   AccountGroup *ag;
   Account *acct;
+  gboolean isTemplateModeTrue;
 
   acct = NULL;
+  isTemplateModeTrue = TRUE;
 
   q = xaccMallocQuery ();
 
@@ -491,7 +497,8 @@
   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 ) {