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

changes to make the documentation format nicely with Doxygen

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@9944 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Linas Vepstas 2004-05-07 04:47:03 +00:00
parent 27b3b9bec6
commit d4fbf9c7f9
6 changed files with 116 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/business/business-core/gncAddress.h
View File

@ -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 Address
@{ */
/** @file gncAddress.h
@brief an Address object
@author Copyright (C) 2001 Derek Atkins <warlord@MIT.EDU>
*/
#ifndef GNC_ADDRESS_H_
#define GNC_ADDRESS_H_
@ -35,11 +38,14 @@
typedef struct _gncAddress GncAddress;
/* Create/Destroy functions */
/** @name Create/Destroy functions */
/** @{ */
GncAddress * gncAddressCreate (QofBook *book, QofEntity *parent);
void gncAddressDestroy (GncAddress *addr);
/** @} */
/* Set functions */
/** @name Set functions */
/** @{ */
void gncAddressSetName (GncAddress *addr, const char *name);
void gncAddressSetAddr1 (GncAddress *addr, const char *addr1);
@ -50,8 +56,10 @@ void gncAddressSetPhone (GncAddress *addr, const char *phone);
void gncAddressSetFax (GncAddress *addr, const char *fax);
void gncAddressSetEmail (GncAddress *addr, const char *email);
void gncAddressClearDirty (GncAddress *address);
/** @} */
/* Get Functions */
/** @name Get Functions */
/** @{ */
const char * gncAddressGetName (const GncAddress *addr);
const char * gncAddressGetAddr1 (const GncAddress *addr);
@ -61,6 +69,8 @@ const char * gncAddressGetAddr4 (const GncAddress *addr);
const char * gncAddressGetPhone (const GncAddress *addr);
const char * gncAddressGetFax (const GncAddress *addr);
const char * gncAddressGetEmail (const GncAddress *addr);
/** @} */
gboolean gncAddressIsDirty (const GncAddress *addr);
int gncAddressCompare (const GncAddress *a, const GncAddress *b);
@ -71,3 +81,5 @@ int gncAddressCompare (const GncAddress *a, const GncAddress *b);
#define ADDRESS_EMAIL "email"
#endif /* GNC_ADDRESS_H_ */
/** @} */
/** @} */

41
src/business/business-core/gncBillTerm.h
View File

@ -19,11 +19,14 @@
* Boston, MA 02111-1307, USA gnu@gnu.org *
* *
\********************************************************************/
/*
* Copyright (C) 2002 Derek Atkins
* Author: Derek Atkins <warlord@MIT.EDU>
*/
/** @addtogroup Business
@{ */
/** @addtogroup BillTerm
@{ */
/** @file gncBillTerm.h
@brief Billing Term interface
@author Copyright (C) 2002 Derek Atkins <warlord@MIT.EDU>
*/
#ifndef GNC_BILLTERM_H_
#define GNC_BILLTERM_H_
@ -41,7 +44,7 @@ typedef struct _gncBillTerm GncBillTerm;
#define GNC_IS_BILLTERM(obj) (QOF_CHECK_TYPE((obj), GNC_ID_BILLTERM))
#define GNC_BILLTERM(obj) (QOF_CHECK_CAST((obj), GNC_ID_BILLTERM, GncBillTerm))
/*
/**
* How to interpret the amount.
* You can interpret it as a VALUE or a PERCENT.
* ??? huh?
@ -51,11 +54,19 @@ typedef enum {
GNC_TERM_TYPE_PROXIMO,
} GncBillTermType;
/* Create/Destroy Functions */
/** @name Create/Destroy Functions */
/** @{ */
GncBillTerm * gncBillTermCreate (QofBook *book);
void gncBillTermDestroy (GncBillTerm *term);
void gncBillTermIncRef (GncBillTerm *term);
void gncBillTermDecRef (GncBillTerm *term);
/* Set Functions */
void gncBillTermChanged (GncBillTerm *term);
void gncBillTermBeginEdit (GncBillTerm *term);
void gncBillTermCommitEdit (GncBillTerm *term);
/** @} */
/** @name Set Functions */
void gncBillTermSetName (GncBillTerm *term, const char *name);
void gncBillTermSetDescription (GncBillTerm *term, const char *name);
void gncBillTermSetType (GncBillTerm *term, GncBillTermType type);
@ -64,15 +75,10 @@ void gncBillTermSetDiscountDays (GncBillTerm *term, gint days);
void gncBillTermSetDiscount (GncBillTerm *term, gnc_numeric discount);
void gncBillTermSetCutoff (GncBillTerm *term, gint cutoff);
void gncBillTermIncRef (GncBillTerm *term);
void gncBillTermDecRef (GncBillTerm *term);
void gncBillTermChanged (GncBillTerm *term);
void gncBillTermBeginEdit (GncBillTerm *term);
void gncBillTermCommitEdit (GncBillTerm *term);
/* Get Functions */
/** @} */
/** @name Get Functions */
/** @{ */
/** Return a pointer to the instance gncBillTerm that is identified
* by the guid, and is residing in the book. Returns NULL if the
* instance can't be found.
@ -100,6 +106,7 @@ GncBillTerm *gncBillTermGetParent (GncBillTerm *term);
GncBillTerm *gncBillTermReturnChild (GncBillTerm *term, gboolean make_new);
#define gncBillTermGetChild(t) gncBillTermReturnChild((t),FALSE)
gint64 gncBillTermGetRefcount (GncBillTerm *term);
/** @} */
int gncBillTermCompare (GncBillTerm *a, GncBillTerm *b);
@ -114,3 +121,5 @@ Timespec gncBillTermComputeDiscountDate (GncBillTerm *term, Timespec post_date);
#define gncBillTermGetGUID(x) qof_instance_get_guid (QOF_INSTANCE(x))
#endif /* GNC_BILLTERM_H_ */
/** @} */
/** @} */

22
src/business/business-core/gncBusiness.h
View File

@ -1,7 +1,4 @@
/*
* gncBusiness.h -- Business Helper Functions
* Copyright (C) 2002 Derek Atkins
* Author: Derek Atkins <warlord@MIT.EDU>
/* gncBusiness.h -- Business Helper Functions
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
@ -19,15 +16,26 @@
* Free Software Foundation Voice: +1-617-542-5942
* 59 Temple Place - Suite 330 Fax: +1-617-542-2652
* Boston, MA 02111-1307, USA gnu@gnu.org
*
* Currently mostly not used ...
*/
/** @addtogroup Engine
@{ */
/** @addtogroup Business
The Business Engine provides a set of structures for
that provide small-business accounting features.
@{ */
/** @file gncBusiness.h -- Business Helper Functions
* @author Copyright (C) 2002 Derek Atkins
* @author Derek Atkins <warlord@MIT.EDU>
*/
/** @} */
/** @} */
#ifndef GNC_BUSINESS_H_
#define GNC_BUSINESS_H_
/* deprecated backwards-compat definitions */
/* @deprecated backwards-compat definitions */
#define GNC_BILLTERM_MODULE_NAME GNC_ID_BILLTERM
#define GNC_CUSTOMER_MODULE_NAME GNC_ID_CUSTOMER
#define GNC_EMPLOYEE_MODULE_NAME GNC_ID_EMPLOYEE

35
src/business/business-core/gncCustomer.h
View File

@ -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 Customer
@{ */
/** @file gncCustomer.h
@brief Core Customer Interface
@author Copyright (C) 2001,2002 Derek Atkins <warlord@MIT.EDU>
*/
#ifndef GNC_CUSTOMER_H_
#define GNC_CUSTOMER_H_
@ -45,12 +48,16 @@ typedef struct _gncCustomer GncCustomer;
#define GNC_IS_CUSTOMER(obj) (QOF_CHECK_TYPE((obj), GNC_ID_CUSTOMER))
#define GNC_CUSTOMER(obj) (QOF_CHECK_CAST((obj), GNC_ID_CUSTOMER, GncCustomer))
/* Create/Destroy Functions */
/** @name Create/Destroy Functions */
/** @{ */
GncCustomer *gncCustomerCreate (QofBook *book);
void gncCustomerDestroy (GncCustomer *customer);
void gncCustomerBeginEdit (GncCustomer *customer);
void gncCustomerCommitEdit (GncCustomer *customer);
/** @} */
/* Set Functions */
/** @name Set Functions */
/** @{ */
void gncCustomerSetID (GncCustomer *customer, const char *id);
void gncCustomerSetName (GncCustomer *customer, const char *name);
@ -67,11 +74,10 @@ void gncCustomerSetTaxTable (GncCustomer *customer, GncTaxTable *table);
void gncCustomerAddJob (GncCustomer *customer, GncJob *job);
void gncCustomerRemoveJob (GncCustomer *customer, GncJob *job);
/** @} */
void gncCustomerBeginEdit (GncCustomer *customer);
void gncCustomerCommitEdit (GncCustomer *customer);
/* Get Functions */
/** @name Get Functions */
/** @{ */
/** Return a pointer to the instance gncCustomer that is identified
* by the guid, and is residing in the book. Returns NULL if the
* instance can't be found.
@ -98,6 +104,7 @@ GncTaxTable* gncCustomerGetTaxTable (GncCustomer *customer);
KvpFrame *gncCustomerGetSlots (GncCustomer *customer);
GList * gncCustomerGetJoblist (GncCustomer *customer, gboolean show_all);
/** @} */
@ -109,10 +116,12 @@ int gncCustomerCompare (GncCustomer *a, GncCustomer *b);
#define CUSTOMER_ADDR "addr"
#define CUSTOMER_SHIPADDR "shipaddr"
/* deprecated functions, should be removed */
/** @deprecated functions, should be removed */
#define gncCustomerGetGUID(x) qof_instance_get_guid(QOF_INSTANCE(x))
#define gncCustomerRetGUID(x) (x ? *(qof_instance_get_guid(QOF_INSTANCE(x))) : *(guid_null()))
#define gncCustomerGetBook(x) qof_instance_get_book(QOF_INSTANCE(x))
#define gncCustomerLookupDirect(g,b) gncCustomerLookup((b), &(g))
#endif /* GNC_CUSTOMER_H_ */
/** @} */
/** @} */

36
src/business/business-core/gncEmployee.h
View File

@ -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 Employee
@{ */
/** @file gncEmployee.h
@brief Employee Interface
@author Copyright (C) 2001 Derek Atkins <warlord@MIT.EDU>
*/
#ifndef GNC_EMPLOYEE_H_
#define GNC_EMPLOYEE_H_
@ -40,13 +43,17 @@ typedef struct _gncEmployee GncEmployee;
#define GNC_IS_EMPLOYEE(obj) (QOF_CHECK_TYPE((obj), GNC_ID_EMPLOYEE))
#define GNC_EMPLOYEE(obj) (QOF_CHECK_CAST((obj), GNC_ID_EMPLOYEE, GncEmployee))
/* Create/Destroy Functions */
/** @name Create/Destroy Functions */
/** @{ */
GncEmployee *gncEmployeeCreate (QofBook *book);
void gncEmployeeDestroy (GncEmployee *employee);
void gncEmployeeBeginEdit (GncEmployee *employee);
void gncEmployeeCommitEdit (GncEmployee *employee);
int gncEmployeeCompare (GncEmployee *a, GncEmployee *b);
/** @} */
/* Set Functions */
/** @name Set Functions */
/** @{ */
void gncEmployeeSetID (GncEmployee *employee, const char *id);
void gncEmployeeSetUsername (GncEmployee *employee, const char *username);
void gncEmployeeSetLanguage (GncEmployee *employee, const char *language);
@ -56,9 +63,10 @@ void gncEmployeeSetRate (GncEmployee *employee, gnc_numeric rate);
void gncEmployeeSetCurrency (GncEmployee *employee, gnc_commodity * currency);
void gncEmployeeSetActive (GncEmployee *employee, gboolean active);
void gncEmployeeSetCCard (GncEmployee *employee, Account* ccard_acc);
/** @} */
/* Get Functions */
/** @name Get Functions */
/** @{ */
QofBook * gncEmployeeGetBook (GncEmployee *employee);
const char * gncEmployeeGetID (GncEmployee *employee);
const char * gncEmployeeGetUsername (GncEmployee *employee);
@ -70,6 +78,7 @@ gnc_numeric gncEmployeeGetRate (GncEmployee *employee);
gnc_commodity * gncEmployeeGetCurrency (GncEmployee *employee);
gboolean gncEmployeeGetActive (GncEmployee *employee);
Account * gncEmployeeGetCCard (GncEmployee *employee);
/** @} */
/** Return a pointer to the instance gncEmployee that is identified
@ -84,9 +93,6 @@ Account * gncEmployeeGetCCard (GncEmployee *employee);
gboolean gncEmployeeIsDirty (GncEmployee *employee);
void gncEmployeeBeginEdit (GncEmployee *employee);
void gncEmployeeCommitEdit (GncEmployee *employee);
int gncEmployeeCompare (GncEmployee *a, GncEmployee *b);
#define EMPLOYEE_ID "id"
#define EMPLOYEE_USERNAME "username"
@ -98,3 +104,5 @@ int gncEmployeeCompare (GncEmployee *a, GncEmployee *b);
#define gncEmployeeLookupDirect(G,B) gncEmployeeLookup((B),&(G))
#endif /* GNC_EMPLOYEE_H_ */
/** @} */
/** @} */

17
src/business/business-core/gncTaxTable.h
View File

@ -19,10 +19,12 @@
* Boston, MA 02111-1307, USA gnu@gnu.org *
* *
\********************************************************************/
/** @addtogroup Business-Engine
/** @addtogroup Business
@{ */
/** @addtogroup TaxTable
@{ */
/** @file gncTaxTable.h
@breif Tax Table programming interface
@brief Tax Table programming interface
@author Copyright (C) 2002 Derek Atkins <warlord@MIT.EDU>
*/
@ -67,7 +69,8 @@ gboolean gncAmountStringToType (const char *str, GncAmountType *type);
const char * gncTaxIncludedTypeToString (GncTaxIncluded type);
gboolean gncTaxIncludedStringToType (const char *str, GncTaxIncluded *type);
/** Create/Destroy Functions */
/** @name Create/Destroy Functions */
/** @{ */
GncTaxTable * gncTaxTableCreate (QofBook *book);
void gncTaxTableDestroy (GncTaxTable *table);
GncTaxTableEntry * gncTaxTableEntryCreate (void);
@ -88,8 +91,10 @@ void gncTaxTableRemoveEntry (GncTaxTable *table, GncTaxTableEntry *entry);
void gncTaxTableChanged (GncTaxTable *table);
void gncTaxTableBeginEdit (GncTaxTable *table);
void gncTaxTableCommitEdit (GncTaxTable *table);
/** @} */
/** Get Functions */
/** @name Get Functions */
/** @{ */
/** Return a pointer to the instance gncTaxTable that is identified
* by the guid, and is residing in the book. Returns NULL if the
@ -115,6 +120,7 @@ Timespec gncTaxTableLastModified (GncTaxTable *table);
Account * gncTaxTableEntryGetAccount (GncTaxTableEntry *entry);
GncAmountType gncTaxTableEntryGetType (GncTaxTableEntry *entry);
gnc_numeric gncTaxTableEntryGetAmount (GncTaxTableEntry *entry);
/** @} */
int gncTaxTableCompare (GncTaxTable *a, GncTaxTable *b);
int gncTaxTableEntryCompare (GncTaxTableEntry *a, GncTaxTableEntry *b);
@ -141,10 +147,11 @@ gnc_numeric gncAccountValueTotal (GList *list);
/** Destroy a list of accountvalues */
void gncAccountValueDestroy (GList *list);
/** deprecated routine */
/** @deprecated routine */
#define gncTaxTableGetGUID(x) qof_instance_get_guid(QOF_INSTANCE(x))
#define gncTaxTableRetGUID(x) (x ? *(qof_instance_get_guid(QOF_INSTANCE(x))) : *(guid_null()))
#define gncTaxTableLookupDirect(G,B) gncTaxTableLookup((B), &(G))
#endif /* GNC_TAXTABLE_H_ */
/** @} */
/** @} */