From 4a9d0cb0ecca2aac9a64a714ed1d8c0d4e020eb1 Mon Sep 17 00:00:00 2001 From: Dave Peticolas Date: Thu, 7 Jun 2001 08:22:52 +0000 Subject: [PATCH] 2001-06-07 Dave Peticolas * src/doc/design/gnucash-design.texinfo: update docs * src/doc/design/engine.texinfo: update docs git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@4503 57a11ea4-9604-0410-9ed3-97b8803252fd --- ChangeLog | 6 ++++ src/doc/design/engine.texinfo | 42 +++++++++++++++++++++++++-- src/doc/design/gnucash-design.texinfo | 5 ++++ 3 files changed, 51 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index cdb5c07fde..17ab3da1e8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2001-06-07 Dave Peticolas + + * src/doc/design/gnucash-design.texinfo: update docs + + * src/doc/design/engine.texinfo: update docs + 2001-06-06 Dave Peticolas * src/scm/report-html.scm: remove unneeded (require 'printf). diff --git a/src/doc/design/engine.texinfo b/src/doc/design/engine.texinfo index 2fa3783266..35dc2ad415 100644 --- a/src/doc/design/engine.texinfo +++ b/src/doc/design/engine.texinfo @@ -28,6 +28,7 @@ be created as a shared library for use by other programs. * Commodities:: * Commodity Tables:: * Prices:: +* Price Databases:: * Splits:: * Transactions:: * Accounts:: @@ -1425,7 +1426,7 @@ ISO4217 namespace. @end deftypefun -@node Prices, Splits, Commodity Tables, Engine +@node Prices, Price Databases, Commodity Tables, Engine @section Prices @tindex GNCPrice @@ -1610,7 +1611,44 @@ Set the version of @var{p} to @var{versn}. @end deftypefun -@node Splits, Transactions, Prices, Engine +@node Price Databases, Splits, Prices, Engine +@section Price Databases +@tindex GNCPriceDB + +A Price Database stores GNCPrices and allows prices to be looked +up based on currency, commodity, and time. + + +@menu +* Price Lists:: +@end menu + + +@node Price Lists, , Price Databases, Price Databases +@subsection Price Lists + +Price Lists are used by Price Databases to organize prices for a given +commodity and currency. A Price List is a list of prices with the same +commodity and currency, sorted by decreasing time (earlier prices come +later in the list). + +@deftypefun gboolean gnc_price_list_insert (GList ** @var{prices}, GNCPrice * @var{p}) +Insert price @var{p} into the list @var{prices}, calling +@var{gnc_price_ref} on @var{p} during the process. +@end deftypefun + +@deftypefun gboolean gnc_price_list_remove (GList ** @var{prices}, GNCPrice * @var{p}) +Remove price @var{p} from the list @var{prices}, calling +@code{gnc_price_unref} on @var{p} during the process. +@end deftypefun + +@deftypefun void gnc_price_list_destroy (GList * @var{prices}) +Destroy the price list @var{prices}, calling @code{gnc_price_unref} +on all the prices in the list. +@end deftypefun + + +@node Splits, Transactions, Price Databases, Engine @section Splits @tindex Split diff --git a/src/doc/design/gnucash-design.texinfo b/src/doc/design/gnucash-design.texinfo index 58cd0374b6..3ec9c3ba35 100644 --- a/src/doc/design/gnucash-design.texinfo +++ b/src/doc/design/gnucash-design.texinfo @@ -89,6 +89,7 @@ Engine * Commodities:: * Commodity Tables:: * Prices:: +* Price Databases:: * Splits:: * Transactions:: * Accounts:: @@ -146,6 +147,10 @@ Prices * Price Getters:: * Price Setters:: +Price Databases + +* Price Lists:: + Splits * General Split API::