mirror of
https://github.com/Gnucash/gnucash.git
synced 2024-11-25 18:30:23 -06:00
add markup to get these files to appear in the Doxygen documentation
system git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@9946 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Linas Vepstas
parent
23124f665b
commit
1471882a35
@ -19,11 +19,14 @@
|
||||
* Boston, MA 02111-1307, USA gnu@gnu.org *
|
||||
* *
|
||||
\********************************************************************/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2001,2002 Derek Atkins
|
||||
* Author: Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
/** @addtogroup Business
|
||||
@{ */
|
||||
/** @addtogroup Entry
|
||||
@{ */
|
||||
/** @file gncEntry.h
|
||||
@brief Business Entry Interface
|
||||
@author Copyright (C) 2001,2002 Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
|
||||
#ifndef GNC_ENTRY_H_
|
||||
#define GNC_ENTRY_H_
|
||||
@ -54,7 +57,7 @@ typedef enum {
|
||||
#define GNC_IS_ENTRY(obj) (QOF_CHECK_TYPE((obj), GNC_ID_ENTRY))
|
||||
#define GNC_ENTRY(obj) (QOF_CHECK_CAST((obj), GNC_ID_ENTRY, GncEntry))
|
||||
|
||||
/* How to apply the discount and taxes. There are three distinct ways to
|
||||
/** How to apply the discount and taxes. There are three distinct ways to
|
||||
* apply them:
|
||||
*
|
||||
* Type: discount tax
|
||||
@ -69,22 +72,26 @@ gboolean gncEntryDiscountStringToHow (const char *str, GncDiscountHow *how);
|
||||
const char * gncEntryPaymentTypeToString (GncEntryPaymentType type);
|
||||
gboolean gncEntryPaymentStringToType (const char *str, GncEntryPaymentType *type);
|
||||
|
||||
/* Create/Destroy Functions */
|
||||
|
||||
/** @name Create/Destroy Functions */
|
||||
/** @{ */
|
||||
GncEntry *gncEntryCreate (QofBook *book);
|
||||
void gncEntryDestroy (GncEntry *entry);
|
||||
/** @} */
|
||||
|
||||
/* SET FUNCTIONS */
|
||||
|
||||
/* Generic (shared) data */
|
||||
/** @name Generic (shared) data */
|
||||
/** @{ */
|
||||
void gncEntrySetDate (GncEntry *entry, Timespec date);
|
||||
void gncEntrySetDateEntered (GncEntry *entry, Timespec date);
|
||||
void gncEntrySetDescription (GncEntry *entry, const char *desc);
|
||||
void gncEntrySetAction (GncEntry *entry, const char *action);
|
||||
void gncEntrySetNotes (GncEntry *entry, const char *notes);
|
||||
void gncEntrySetQuantity (GncEntry *entry, gnc_numeric quantity);
|
||||
/** @} */
|
||||
|
||||
/* Customer Invoices */
|
||||
/** @name Customer Invoices */
|
||||
/** @{ */
|
||||
void gncEntrySetInvAccount (GncEntry *entry, Account *acc);
|
||||
void gncEntrySetInvPrice (GncEntry *entry, gnc_numeric price);
|
||||
void gncEntrySetInvTaxable (GncEntry *entry, gboolean taxable);
|
||||
@ -93,8 +100,10 @@ void gncEntrySetInvTaxTable (GncEntry *entry, GncTaxTable *table);
|
||||
void gncEntrySetInvDiscount (GncEntry *entry, gnc_numeric discount);
|
||||
void gncEntrySetInvDiscountType (GncEntry *entry, GncAmountType type);
|
||||
void gncEntrySetInvDiscountHow (GncEntry *entry, GncDiscountHow how);
|
||||
/** @} */
|
||||
|
||||
/* Vendor Bills (and Employee Expenses) */
|
||||
/** @name Vendor Bills (and Employee Expenses) */
|
||||
/** @{ */
|
||||
void gncEntrySetBillAccount (GncEntry *entry, Account *acc);
|
||||
void gncEntrySetBillPrice (GncEntry *entry, gnc_numeric price);
|
||||
void gncEntrySetBillTaxable (GncEntry *entry, gboolean taxable);
|
||||
@ -102,20 +111,26 @@ void gncEntrySetBillTaxIncluded (GncEntry *entry, gboolean tax_included);
|
||||
void gncEntrySetBillTaxTable (GncEntry *entry, GncTaxTable *table);
|
||||
void gncEntrySetBillable (GncEntry *entry, gboolean billable);
|
||||
void gncEntrySetBillTo (GncEntry *entry, GncOwner *billto);
|
||||
/** @} */
|
||||
|
||||
/* employee-stuff */
|
||||
/** @name employee-stuff */
|
||||
/** @{ */
|
||||
void gncEntrySetBillPayment (GncEntry *entry, GncEntryPaymentType type);
|
||||
/** @} */
|
||||
|
||||
/* GET FUNCTIONS */
|
||||
/* Generic (shared) data */
|
||||
/** @name Generic (shared) data */
|
||||
/** @{ */
|
||||
Timespec gncEntryGetDate (GncEntry *entry);
|
||||
Timespec gncEntryGetDateEntered (GncEntry *entry);
|
||||
const char * gncEntryGetDescription (GncEntry *entry);
|
||||
const char * gncEntryGetAction (GncEntry *entry);
|
||||
const char * gncEntryGetNotes (GncEntry *notes);
|
||||
gnc_numeric gncEntryGetQuantity (GncEntry *entry);
|
||||
/** @} */
|
||||
|
||||
/* Customer Invoices */
|
||||
/** @name Customer Invoices */
|
||||
/** @{ */
|
||||
Account * gncEntryGetInvAccount (GncEntry *entry);
|
||||
gnc_numeric gncEntryGetInvPrice (GncEntry *entry);
|
||||
gnc_numeric gncEntryGetInvDiscount (GncEntry *entry);
|
||||
@ -124,8 +139,10 @@ GncDiscountHow gncEntryGetInvDiscountHow (GncEntry *entry);
|
||||
gboolean gncEntryGetInvTaxable (GncEntry *entry);
|
||||
gboolean gncEntryGetInvTaxIncluded (GncEntry *entry);
|
||||
GncTaxTable * gncEntryGetInvTaxTable (GncEntry *entry);
|
||||
/** @} */
|
||||
|
||||
/* Vendor Bills (and Employee Expenses) */
|
||||
/** @name Vendor Bills (and Employee Expenses) */
|
||||
/** @{ */
|
||||
Account * gncEntryGetBillAccount (GncEntry *entry);
|
||||
gnc_numeric gncEntryGetBillPrice (GncEntry *entry);
|
||||
gboolean gncEntryGetBillTaxable (GncEntry *entry);
|
||||
@ -135,10 +152,13 @@ gboolean gncEntryGetBillable (GncEntry *entry);
|
||||
GncOwner *gncEntryGetBillTo (GncEntry *entry);
|
||||
|
||||
GncEntryPaymentType gncEntryGetBillPayment (GncEntry* entry);
|
||||
/** @} */
|
||||
|
||||
void gncEntryCopy (const GncEntry *src, GncEntry *dest);
|
||||
|
||||
/* The first three return the rounded values -- the last returns the
|
||||
/** @name Getting Values */
|
||||
/** @{ */
|
||||
/** The first three return the rounded values -- the last returns the
|
||||
* list of unrounded account-values. The list belongs to the entry
|
||||
* and will be destroyed, so use it quickly.
|
||||
*/
|
||||
@ -147,7 +167,7 @@ gnc_numeric gncEntryReturnDiscountValue (GncEntry *entry, gboolean is_inv);
|
||||
gnc_numeric gncEntryReturnTaxValue (GncEntry *entry, gboolean is_inv);
|
||||
GList * gncEntryReturnTaxValues (GncEntry *entry, gboolean is_inv);
|
||||
|
||||
/* Compute the Entry value, tax-value, and discount_value, based on
|
||||
/** Compute the Entry value, tax-value, and discount_value, based on
|
||||
* the quantity, price, discount, tax-table, and types. The value is
|
||||
* the amount the merchant gets, the taxes are what the gov't gets,
|
||||
* and the discount is how much the customer saved.
|
||||
@ -168,6 +188,8 @@ void gncEntryComputeValue (gnc_numeric qty, gnc_numeric price,
|
||||
gnc_numeric *value, gnc_numeric *discount_value,
|
||||
GList **tax_values);
|
||||
|
||||
/** @} */
|
||||
|
||||
GncOrder * gncEntryGetOrder (GncEntry *entry);
|
||||
GncInvoice * gncEntryGetInvoice (GncEntry *entry);
|
||||
GncInvoice * gncEntryGetBill (GncEntry *entry);
|
||||
@ -206,3 +228,5 @@ int gncEntryCompare (GncEntry *a, GncEntry *b);
|
||||
#define gncEntryGetGUID(x) qof_instance_get_guid(QOF_INSTANCE(x))
|
||||
|
||||
#endif /* GNC_ENTRY_H_ */
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
||||
@ -19,11 +19,14 @@
|
||||
* Boston, MA 02111-1307, USA gnu@gnu.org *
|
||||
* *
|
||||
\********************************************************************/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2001 Derek Atkins
|
||||
* Author: Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
/** @addtogroup Business
|
||||
@{ */
|
||||
/** @addtogroup Invoice
|
||||
@{ */
|
||||
/** @file gncInvoice.h
|
||||
@brief Business Invoice Interface
|
||||
@author Copyright (C) 2001 Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
|
||||
#ifndef GNC_INVOICE_H_
|
||||
#define GNC_INVOICE_H_
|
||||
@ -43,13 +46,14 @@ typedef struct _gncInvoice GncInvoice;
|
||||
#define GNC_IS_INVOICE(obj) (QOF_CHECK_TYPE((obj), GNC_ID_INVOICE))
|
||||
#define GNC_INVOICE(obj) (QOF_CHECK_CAST((obj), GNC_ID_INVOICE, GncInvoice))
|
||||
|
||||
/* Create/Destroy Functions */
|
||||
|
||||
/** @name Create/Destroy Functions */
|
||||
/** @{ */
|
||||
GncInvoice *gncInvoiceCreate (QofBook *book);
|
||||
void gncInvoiceDestroy (GncInvoice *invoice);
|
||||
/** @} */
|
||||
|
||||
/* Set Functions */
|
||||
|
||||
/** @name Set Functions */
|
||||
/** @{ */
|
||||
void gncInvoiceSetID (GncInvoice *invoice, const char *id);
|
||||
void gncInvoiceSetOwner (GncInvoice *invoice, GncOwner *owner);
|
||||
void gncInvoiceSetDateOpened (GncInvoice *invoice, Timespec date);
|
||||
@ -61,16 +65,17 @@ void gncInvoiceSetCurrency (GncInvoice *invoice, gnc_commodity *currency);
|
||||
void gncInvoiceSetActive (GncInvoice *invoice, gboolean active);
|
||||
void gncInvoiceSetBillTo (GncInvoice *invoice, GncOwner *billto);
|
||||
void gncInvoiceSetToChargeAmount (GncInvoice *invoice, gnc_numeric amount);
|
||||
/** @} */
|
||||
|
||||
void gncInvoiceAddEntry (GncInvoice *invoice, GncEntry *entry);
|
||||
void gncInvoiceRemoveEntry (GncInvoice *invoice, GncEntry *entry);
|
||||
|
||||
/* Call this function when adding an entry to a bill instead of an invoice */
|
||||
/** Call this function when adding an entry to a bill instead of an invoice */
|
||||
void gncBillAddEntry (GncInvoice *bill, GncEntry *entry);
|
||||
void gncBillRemoveEntry (GncInvoice *bill, GncEntry *entry);
|
||||
|
||||
/* Get Functions */
|
||||
|
||||
/** @name Get Functions */
|
||||
/** @{ */
|
||||
const char * gncInvoiceGetID (GncInvoice *invoice);
|
||||
GncOwner * gncInvoiceGetOwner (GncInvoice *invoice);
|
||||
Timespec gncInvoiceGetDateOpened (GncInvoice *invoice);
|
||||
@ -88,8 +93,9 @@ gboolean gncInvoiceGetActive (GncInvoice *invoice);
|
||||
GNCLot * gncInvoiceGetPostedLot (GncInvoice *invoice);
|
||||
Transaction * gncInvoiceGetPostedTxn (GncInvoice *invoice);
|
||||
Account * gncInvoiceGetPostedAcc (GncInvoice *invoice);
|
||||
/** @} */
|
||||
|
||||
/* return the "total" amount of the invoice */
|
||||
/** return the "total" amount of the invoice */
|
||||
gnc_numeric gncInvoiceGetTotal (GncInvoice *invoice);
|
||||
gnc_numeric gncInvoiceGetTotalOf (GncInvoice *invoice, GncEntryPaymentType type);
|
||||
gnc_numeric gncInvoiceGetTotalSubtotal (GncInvoice *invoice);
|
||||
@ -97,7 +103,7 @@ gnc_numeric gncInvoiceGetTotalTax (GncInvoice *invoice);
|
||||
|
||||
GList * gncInvoiceGetEntries (GncInvoice *invoice);
|
||||
|
||||
/* Post this invoice to an account. Returns the new Transaction
|
||||
/** Post this invoice to an account. Returns the new Transaction
|
||||
* that is tied to this invoice. The transaction is set with
|
||||
* the supplied posted date, due date, and memo. The Transaction
|
||||
* description is set to the name of the company.
|
||||
@ -107,7 +113,7 @@ gncInvoicePostToAccount (GncInvoice *invoice, Account *acc,
|
||||
Timespec *posted_date, Timespec *due_date,
|
||||
const char *memo);
|
||||
|
||||
/*
|
||||
/**
|
||||
* UNpost this invoice. This will destroy the posted transaction and
|
||||
* return the invoice to its unposted state. It may leave empty lots
|
||||
* out there. If reset_tax_tables is TRUE, then it will also revert
|
||||
@ -120,7 +126,7 @@ gncInvoicePostToAccount (GncInvoice *invoice, Account *acc,
|
||||
gboolean
|
||||
gncInvoiceUnpost (GncInvoice *invoice, gboolean reset_tax_tables);
|
||||
|
||||
/*
|
||||
/**
|
||||
* Apply a payment of "amount" for the owner, between the xfer_account
|
||||
* (bank or other asset) and the posted_account (A/R or A/P).
|
||||
*
|
||||
@ -133,10 +139,10 @@ gncOwnerApplyPayment (GncOwner *owner, Account *posted_acc, Account *xfer_acc,
|
||||
const char *memo, const char *num);
|
||||
|
||||
|
||||
/* Given a transaction, find and return the Invoice */
|
||||
/** Given a transaction, find and return the Invoice */
|
||||
GncInvoice * gncInvoiceGetInvoiceFromTxn (Transaction *txn);
|
||||
|
||||
/* Given a LOT, find and return the Invoice attached to the lot */
|
||||
/** Given a LOT, find and return the Invoice attached to the lot */
|
||||
GncInvoice * gncInvoiceGetInvoiceFromLot (GNCLot *lot);
|
||||
|
||||
/** Return a pointer to the instance gncInvoice that is identified
|
||||
@ -181,3 +187,5 @@ gboolean gncInvoiceIsPaid (GncInvoice *invoice);
|
||||
#define gncInvoiceLookupDirect(G,B) gncInvoiceLookup((B),&(G))
|
||||
|
||||
#endif /* GNC_INVOICE_H_ */
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
||||
@ -19,11 +19,14 @@
|
||||
* Boston, MA 02111-1307, USA gnu@gnu.org *
|
||||
* *
|
||||
\********************************************************************/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2001, 2002 Derek Atkins
|
||||
* Author: Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
/** @addtogroup Business
|
||||
@{ */
|
||||
/** @addtogroup Job
|
||||
@{ */
|
||||
/** @file gncJob.h
|
||||
@brief Job Interface
|
||||
@author Copyright (C) 2001, 2002 Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
|
||||
#ifndef GNC_JOB_H_
|
||||
#define GNC_JOB_H_
|
||||
@ -90,3 +93,5 @@ int gncJobCompare (const GncJob *a, const GncJob *b);
|
||||
#define gncJobLookupDirect(G,B) gncJobLookup((B),&(G))
|
||||
|
||||
#endif /* GNC_JOB_H_ */
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
||||
@ -19,11 +19,14 @@
|
||||
* Boston, MA 02111-1307, USA gnu@gnu.org *
|
||||
* *
|
||||
\********************************************************************/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2001 Derek Atkins
|
||||
* Author: Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
/** @addtogroup Business
|
||||
@{ */
|
||||
/** @addtogroup Order
|
||||
@{ */
|
||||
/** @file gncOrder.h
|
||||
@brief Business Order Interface
|
||||
@author Copyright (C) 2001 Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
|
||||
#ifndef GNC_ORDER_H_
|
||||
#define GNC_ORDER_H_
|
||||
@ -101,3 +104,5 @@ gboolean gncOrderIsClosed (GncOrder *order);
|
||||
#define gncOrderGetBook(x) qof_instance_get_book(QOF_INSTANCE(x))
|
||||
|
||||
#endif /* GNC_ORDER_H_ */
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
||||
@ -19,11 +19,14 @@
|
||||
* Boston, MA 02111-1307, USA gnu@gnu.org *
|
||||
* *
|
||||
\********************************************************************/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2001, 2002 Derek Atkins
|
||||
* Author: Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
/** @addtogroup Business
|
||||
@{ */
|
||||
/** @addtogroup Owner
|
||||
@{ */
|
||||
/** @file gncOwner.h
|
||||
@brief Business Interface: Object OWNERs
|
||||
@author Copyright (C) 2001,2002 Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
|
||||
#ifndef GNC_OWNER_H_
|
||||
#define GNC_OWNER_H_
|
||||
@ -78,23 +81,23 @@ int gncOwnerCompare (const GncOwner *a, const GncOwner *b);
|
||||
const char * gncOwnerGetName (GncOwner *owner);
|
||||
gnc_commodity * gncOwnerGetCurrency (GncOwner *owner);
|
||||
|
||||
/* Get the GUID of the immediate owner */
|
||||
/** Get the GUID of the immediate owner */
|
||||
const GUID * gncOwnerGetGUID (GncOwner *owner);
|
||||
GUID gncOwnerRetGUID (GncOwner *owner);
|
||||
|
||||
gboolean gncOwnerIsValid (GncOwner *owner);
|
||||
|
||||
/*
|
||||
/**
|
||||
* Get the "parent" Owner or GUID thereof. The "parent" owner
|
||||
* is the Customer or Vendor, or the Owner of a Job
|
||||
*/
|
||||
GncOwner * gncOwnerGetEndOwner (GncOwner *owner);
|
||||
const GUID * gncOwnerGetEndGUID (GncOwner *owner);
|
||||
|
||||
/* attach an owner to a lot */
|
||||
/** attach an owner to a lot */
|
||||
void gncOwnerAttachToLot (GncOwner *owner, GNCLot *lot);
|
||||
|
||||
/* Get the owner from the lot. If an owner is found in the lot,
|
||||
/** Get the owner from the lot. If an owner is found in the lot,
|
||||
* fill in "owner" and return TRUE. Otherwise return FALSE.
|
||||
*/
|
||||
gboolean gncOwnerGetOwnerFromLot (GNCLot *lot, GncOwner *owner);
|
||||
@ -110,7 +113,7 @@ gboolean gncOwnerGetOwnerFromLot (GNCLot *lot, GncOwner *owner);
|
||||
|
||||
#define OWNER_FROM_LOT "owner-from-lot"
|
||||
|
||||
/*
|
||||
/**
|
||||
* These two functions are mainly for the convenience of scheme code.
|
||||
* Normal C code has no need to ever use these two functions, and rather
|
||||
* can just use a GncOwner directly and just pass around a pointer to it.
|
||||
@ -119,3 +122,5 @@ GncOwner * gncOwnerCreate (void);
|
||||
void gncOwnerDestroy (GncOwner *owner);
|
||||
|
||||
#endif /* GNC_OWNER_H_ */
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
||||
@ -19,11 +19,14 @@
|
||||
* Boston, MA 02111-1307, USA gnu@gnu.org *
|
||||
* *
|
||||
\********************************************************************/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2001, 2002 Derek Atkins
|
||||
* Author: Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
/** @addtogroup Business
|
||||
@{ */
|
||||
/** @addtogroup Vendor
|
||||
@{ */
|
||||
/** @file gncVendor.h
|
||||
@brief Vendor Interface
|
||||
@author Copyright (C) 2001,2002 Derek Atkins <warlord@MIT.EDU>
|
||||
*/
|
||||
|
||||
#ifndef GNC_VENDOR_H_
|
||||
#define GNC_VENDOR_H_
|
||||
@ -107,3 +110,5 @@ int gncVendorCompare (GncVendor *a, GncVendor *b);
|
||||
#define gncVendorLookupDirect(G,B) gncVendorLookup((B),&(G))
|
||||
|
||||
#endif /* GNC_VENDOR_H_ */
|
||||
/** @} */
|
||||
/** @} */
|
||||
|
||||
Loading…
Reference in New Issue
Block a user