From bd710914997b51383c4d3d9ae6282821ad2c89f8 Mon Sep 17 00:00:00 2001 From: Christian Stimming Date: Mon, 8 Aug 2011 07:00:05 +0000 Subject: [PATCH] Minor documentation clarifications. git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@21128 57a11ea4-9604-0410-9ed3-97b8803252fd --- src/engine/Account.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/engine/Account.h b/src/engine/Account.h index 096e5b3f54..7835a917dd 100644 --- a/src/engine/Account.h +++ b/src/engine/Account.h @@ -77,6 +77,10 @@ typedef struct (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_ACCOUNT)) #define GNC_ACCOUNT_GET_CLASS(o) \ (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_ACCOUNT, AccountClass)) +/** Returns the GType type system description of the Account class. + * + * This must not be confused with the \ref GNCAccountType as returned + * by xaccAccountGetType(). */ GType gnc_account_get_type(void); /** The account types are used to determine how the transaction data @@ -299,9 +303,13 @@ void xaccAccountSetNotes (Account *account, const char *notes); void xaccAccountSetLastNum (Account *account, const char *num); /** Set the account's lot order policy */ void gnc_account_set_policy (Account *account, GNCPolicy *policy); -/** Get the account's type */ +/** Returns the account's account type. + * + * This must not be confused with the \ref GType as returned by + * gnc_account_get_type(), which is related to glib's type system. */ GNCAccountType xaccAccountGetType (const Account *account); -/** Is the account a stock, mutual fund or currency? */ +/** Returns true if the account is a stock, mutual fund or currency, + * otherwise false. */ gboolean xaccAccountIsPriced(const Account *acc); /** This function will set the starting commodity balance for this