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

Add Business Ledger to Doxygen docs.

Browse Source
This commit is contained in:
John Ralls 2015-10-15 15:55:18 -07:00
parent eac8aa3491
commit 9ac2bb8158
5 changed files with 52 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/business/business-ledger/gncEntryLedger.h
View File

@ -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 */

9
src/business/business-ledger/gncEntryLedgerControl.h
View File

@ -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 */

9
src/business/business-ledger/gncEntryLedgerLayout.h
View File

@ -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 */

9
src/business/business-ledger/gncEntryLedgerModel.h
View File

@ -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 */

21
src/business/business-ledger/gncEntryLedgerP.h
View File

@ -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 */