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

Minor documentation clarifications.

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@21128 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Christian Stimming 2011-08-08 07:00:05 +00:00
parent 8c5f6ebf5d
commit bd71091499
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/engine/Account.h
View File

@ -77,6 +77,10 @@ typedef struct
(G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_ACCOUNT)) (G_TYPE_CHECK_CLASS_TYPE ((k), GNC_TYPE_ACCOUNT))
#define GNC_ACCOUNT_GET_CLASS(o) \ #define GNC_ACCOUNT_GET_CLASS(o) \
(G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_ACCOUNT, AccountClass)) (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); GType gnc_account_get_type(void);
/** The account types are used to determine how the transaction data /** 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); void xaccAccountSetLastNum (Account *account, const char *num);
/** Set the account's lot order policy */ /** Set the account's lot order policy */
void gnc_account_set_policy (Account *account, GNCPolicy *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); 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); gboolean xaccAccountIsPriced(const Account *acc);
/** This function will set the starting commodity balance for this /** This function will set the starting commodity balance for this