diff --git a/src/business/business-ledger/gncEntryLedger.h b/src/business/business-ledger/gncEntryLedger.h index 3a7532d024..f6a5a227e1 100644 --- a/src/business/business-ledger/gncEntryLedger.h +++ b/src/business/business-ledger/gncEntryLedger.h @@ -28,7 +28,13 @@ #include "gncEntry.h" #include "gncOrder.h" #include "table-allgui.h" - +/** @ingroup Register + * @addtogroup BusinessRegister Business Register + * @brief A specialized register for Accounts Payable and Accounts Receivable. + * @{ + */ +/** @file gncEntryLedger.h + */ typedef enum { GNC_ENTRY_ORDER_NONE = -1, //Force clang to use int representation of enum. @@ -72,31 +78,31 @@ typedef enum typedef struct GncEntryLedger_s GncEntryLedger; -/** Prototypes ***************************************************/ +/* Prototypes ***************************************************/ -/* Create and return a new GncEntry Ledger */ +/** Create and return a new GncEntry Ledger */ GncEntryLedger * gnc_entry_ledger_new (QofBook *book, GncEntryLedgerType type); -/* Set the default order for this ledger */ +/** Set the default order for this ledger */ void gnc_entry_ledger_set_default_order (GncEntryLedger *ledger, GncOrder *order); -/* Set the default invoice for this ledger */ +/** Set the default invoice for this ledger */ void gnc_entry_ledger_set_default_invoice (GncEntryLedger *ledger, GncInvoice *invoice); -/* Destroy the GncEntry Ledger */ +/** Destroy the GncEntry Ledger */ void gnc_entry_ledger_destroy (GncEntryLedger *ledger); -/* Returns the Entry where the cursor is currently located. */ +/** Returns the Entry where the cursor is currently located. */ GncEntry * gnc_entry_ledger_get_current_entry (GncEntryLedger *ledger); -/* Copy GncEntry information from the list to the rows of the Ledger. */ +/** Copy GncEntry information from the list to the rows of the Ledger. */ void gnc_entry_ledger_load (GncEntryLedger *ledger, GList *entry_list); void gnc_entry_ledger_display_refresh (GncEntryLedger *ledger); -/* Get the Table */ +/** Get the Table */ Table * gnc_entry_ledger_get_table (GncEntryLedger *ledger); void gnc_entry_ledger_set_parent (GncEntryLedger *ledger, GtkWidget *parent); @@ -107,10 +113,10 @@ gboolean gnc_entry_ledger_changed (GncEntryLedger *ledger); void gnc_entry_ledger_cancel_cursor_changes (GncEntryLedger *ledger); -/* This will act just like hitting 'return' to record an entry */ +/** This will act just like hitting 'return' to record an entry */ gboolean gnc_entry_ledger_commit_entry (GncEntryLedger *ledger); -/* This will ask the user if they really want to make a change */ +/** This will ask the user if they really want to make a change */ gboolean gnc_entry_ledger_check_close (GtkWidget *parent, GncEntryLedger *ledger); void gnc_entry_ledger_reset_query (GncEntryLedger *ledger); @@ -147,5 +153,5 @@ void gnc_entry_ledger_move_current_entry_updown (GncEntryLedger *ledger, QofQuery * gnc_entry_ledger_get_query (GncEntryLedger *ledger); void gnc_entry_ledger_set_prefs_group (GncEntryLedger *ledger, const gchar *string); - +/** @} */ #endif /* GNC_ENTRY_LEDGER_H */ diff --git a/src/business/business-ledger/gncEntryLedgerControl.h b/src/business/business-ledger/gncEntryLedgerControl.h index 59eb843031..8be6a509b8 100644 --- a/src/business/business-ledger/gncEntryLedgerControl.h +++ b/src/business/business-ledger/gncEntryLedgerControl.h @@ -25,7 +25,12 @@ #define GNC_ENTRY_LEDGER_CONTROL_H #include "gncEntryLedger.h" - +/** @ingroup Register + * @addtogroup BusinessRegister + * @{ + */ +/** @file gncEntryLedgerControl.h + */ TableControl * gnc_entry_ledger_control_new (void); - +/** @} */ #endif /* GNC_ENTRY_LEDGER_CONTROL_H */ diff --git a/src/business/business-ledger/gncEntryLedgerLayout.h b/src/business/business-ledger/gncEntryLedgerLayout.h index 87cf4c41b9..918889c56a 100644 --- a/src/business/business-ledger/gncEntryLedgerLayout.h +++ b/src/business/business-ledger/gncEntryLedgerLayout.h @@ -25,7 +25,12 @@ #define GNC_ENTRY_LEDGER_LAYOUT_H #include "gncEntryLedger.h" - +/** @ingroup Register + * @addtogroup BusinessRegister + * @{ + */ +/** @file gncEntryLedgerLayout.h + */ TableLayout * gnc_entry_ledger_layout_new (GncEntryLedger *ledger); - +/** @} */ #endif /* GNC_ENTRY_LEDGER_LAYOUT_H */ diff --git a/src/business/business-ledger/gncEntryLedgerModel.h b/src/business/business-ledger/gncEntryLedgerModel.h index decc13a4d2..7fabd23761 100644 --- a/src/business/business-ledger/gncEntryLedgerModel.h +++ b/src/business/business-ledger/gncEntryLedgerModel.h @@ -25,7 +25,12 @@ #define GNC_ENTRY_LEDGER_MODEL_H #include "gncEntryLedger.h" - +/** @ingroup Register + * @addtogroup BusinessRegister + * @{ + */ +/** @file gncEntryLedgerModel.h + */ TableModel * gnc_entry_ledger_model_new (GncEntryLedgerType type); - +/** @} */ #endif /* GNC_ENTRY_LEDGER_MODEL_H */ diff --git a/src/business/business-ledger/gncEntryLedgerP.h b/src/business/business-ledger/gncEntryLedgerP.h index c04f7c376a..ad558f1e32 100644 --- a/src/business/business-ledger/gncEntryLedgerP.h +++ b/src/business/business-ledger/gncEntryLedgerP.h @@ -27,20 +27,25 @@ #include "qof.h" #include "table-allgui.h" #include "gncEntryLedger.h" - +/** @ingroup Register + * @addtogroup BusinessRegister + * @{ + */ +/** @file gncEntryLedgerP.h + */ struct GncEntryLedger_s { GncGUID blank_entry_guid; gboolean blank_entry_edited; gboolean traverse_to_new; - gboolean loading; /* To keep from recursing from events */ - gboolean full_refresh; /* Is a full refresh ok? */ - gint component_id; /* To register for events */ + gboolean loading; /** To keep from recursing from events */ + gboolean full_refresh; /** Is a full refresh ok? */ + gint component_id; /** To register for events */ GDate last_date_entered; - GncEntry * hint_entry; /* A Hint for where to display */ + GncEntry * hint_entry; /** A Hint for where to display */ GtkWidget * parent; QofBook * book; @@ -51,8 +56,8 @@ struct GncEntryLedger_s GncEntryLedgerType type; - gboolean is_cust_doc; /* is this document customer or vendor related ? */ - gboolean is_credit_note; /* is this an invoice (or a bill)? */ + gboolean is_cust_doc; /** is this document customer or vendor related ? */ + gboolean is_credit_note; /** is this an invoice (or a bill)? */ const gchar * prefs_group; }; @@ -88,5 +93,5 @@ void gnc_entry_ledger_display_fini (GncEntryLedger *ledger); void gnc_entry_ledger_compute_value (GncEntryLedger *ledger, gnc_numeric *value, gnc_numeric *tax_value); - +/** @} */ #endif /* GNC_ENTRY_LEDGERP_H */