r20803 - gnucash/trunk/src/engine - Clarify documentation of gnc_account_get_children() vs. xaccAccountGetSplitList().

[Christian Stimming]

Author: cstim
Date: 2011-06-27 04:02:15 -0400 (Mon, 27 Jun 2011)
New Revision: 20803
Trac: http://svn.gnucash.org/trac/changeset/20803

Modified:
   gnucash/trunk/src/engine/Account.h
Log:
Clarify documentation of gnc_account_get_children() vs. xaccAccountGetSplitList().

Modified: gnucash/trunk/src/engine/Account.h
===================================================================
--- gnucash/trunk/src/engine/Account.h	2011-06-27 07:23:59 UTC (rev 20802)
+++ gnucash/trunk/src/engine/Account.h	2011-06-27 08:02:15 UTC (rev 20803)
@@ -678,17 +678,25 @@
  *  @return TRUE if this account is of type ROOT.  FALSE otherwise. */
 gboolean gnc_account_is_root (const Account *account);
 
-/** This routine returns a GList of all children of the specified
+/** This routine returns a GList of all children accounts of the specified
  *  account.  This function only returns the immediate children of the
  *  specified account.  For a list of all descendant accounts, use the
  *  gnc_account_get_descendants() function.
  *
+ *  If you are looking for the splits of this account, use
+ *  xaccAccountGetSplitList() instead. This function here deals with
+ *  children accounts inside the account tree.
+ *
  *  @param account The account whose children should be returned.
  *
  *  @return A GList of account pointers, or NULL if there are no
- *  children. It is the callers responsibility to free any returned
+ *  children accounts. It is the callers responsibility to free any returned
  *  list with the g_list_free() function. */
 GList *gnc_account_get_children (const Account *account);
+
+/** This routine returns a GList of all children accounts of the specified
+ *  account, ordered by xaccAccountOrder().  \sa gnc_account_get_children()
+ */
 GList *gnc_account_get_children_sorted (const Account *account);
 
 /** Return the number of children of the specified account.  The