diff --git a/src/engine/gnc-book-p.h b/src/engine/gnc-book-p.h index bb953a2dec..7b06c8ee7d 100644 --- a/src/engine/gnc-book-p.h +++ b/src/engine/gnc-book-p.h @@ -38,19 +38,20 @@ struct gnc_book_struct { - /* Unique guid for this book */ + /* Unique guid for this book. */ GUID guid; - /* The kvp_frame providea a place for top-level data associated + /* The kvp_frame provides a place for top-level data associated * with this book. */ kvp_frame *kvp_data; /* The entity table associates the GUIDs of all the objects - * created in the session with their respective objects - * (pointer addresses) */ + * belonging to this book, with their pointers to the respective + * objects. This allows a lookup of objects based on thier guid. + */ GNCEntityTable *entity_table; - /* Pointers to top-level data structures */ + /* Pointers to top-level data structures. */ AccountGroup *topgroup; GNCPriceDB *pricedb; @@ -87,7 +88,7 @@ struct gnc_book_struct /* * These gnc_book_set_*() routines are used by backends to * initialize the pointers in the book structure to - * soemthing that contains actual data. These routines + * something that contains actual data. These routines * should not be used otherwise. (Its somewhat questionable * if the backends should even be doing this much, but for * backwards compatibility, we leave these here.) @@ -102,11 +103,10 @@ void gnc_book_set_backend (GNCBook *book, Backend *be); GNCEntityTable * gnc_book_get_entity_table (GNCBook *book); -/* - * used by backends to mark the notsaved as FALSE just after - * loading. Do not use otherwise! +/* The gnc_book_mark_saved() routine marks the book as having been + * saved (to a file, to a database). Used by backends to mark the + * notsaved flag as FALSE just after loading. Do not use otherwise! */ - void gnc_book_mark_saved(GNCBook *book); #endif /* GNC_BOOK_P_H */ diff --git a/src/engine/gnc-book.c b/src/engine/gnc-book.c index 30f40138db..2a7a9b9893 100644 --- a/src/engine/gnc-book.c +++ b/src/engine/gnc-book.c @@ -25,6 +25,7 @@ * * FUNCTION: * Encapsulate all the information about a gnucash dataset. + * See src/doc/books.txt for design overview. * * HISTORY: * Created by Linas Vepstas December 1998 diff --git a/src/engine/gnc-book.h b/src/engine/gnc-book.h index 93dd66664e..6503f5e104 100644 --- a/src/engine/gnc-book.h +++ b/src/engine/gnc-book.h @@ -26,6 +26,7 @@ * * FUNCTION: * Encapsulate all the information about a gnucash dataset. + * See src/docs/books.txt for implementation overview. * * HISTORY: * Created by Linas Vepstas December 1998