IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation of gnc_account_get_children() vs. xaccAccountGetSplitList().

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@20803 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Christian Stimming
2011-06-27 08:02:15 +00:00
parent 378a153d16
commit 64418350b7
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/engine/Account.h
View File

@@ -678,17 +678,25 @@ Account * gnc_account_get_root (Account *account);
* @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