qof headers and typo fixups

Chris Shoemaker c.shoemaker at cox.net
Fri Dec 31 16:52:10 EST 2004


* #include "qof/foo" -> #include "foo"
* general fixed typos and comments.
-------------- next part --------------
Index: src/engine/qofbook.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/qofbook.h,v
retrieving revision 1.5.2.5
diff -u -r1.5.2.5 qofbook.h
--- src/engine/qofbook.h	25 Aug 2004 22:46:42 -0000	1.5.2.5
+++ src/engine/qofbook.h	31 Dec 2004 21:43:48 -0000
@@ -81,7 +81,14 @@
     associated with it. */
 void      qof_book_destroy (QofBook *book);
 
-/** \return The table of entities of the given type. 
+/** \return The table of entities of the given type.  
+ *
+ *  When an object's constructor calls qof_instance_init(), a
+ *  reference to the object is stored in the book.  The book stores
+ *  all the references to initialized instances, sorted by type.  This
+ *  function returns a collection of the references for the specified
+ *  type.
+ * 
  *  If the collection doesn't yet exist for the indicated type,
  *  it is created.  Thus, this routine is gaurenteed to return
  *  a non-NULL value.  (Unless the system malloc failed (out of 
@@ -94,11 +101,11 @@
 void qof_book_foreach_collection (QofBook *, QofCollectionForeachCB, gpointer);
 
 /** \return The kvp data for the book.
- *  Note that the boom KVP data is persistant, and is stored/retrevied
+ *  Note that the book KVP data is persistant, and is stored/retrieved
  *  from the file/database.  Thus, the book KVP is the correct place to
  *  store data that needs to be persistant accross sessions (or shared
  *  between multiple users).  To store application runtime data, use
- *  qof_book_set_data() isntead.
+ *  qof_book_set_data() instead.
  */
 #define qof_book_get_slots(book) qof_instance_get_slots(QOF_INSTANCE(book))
 
@@ -120,7 +127,7 @@
  */
 void qof_book_set_data_fin (QofBook *book, const char *key, gpointer data, QofBookFinalCB);
 
-/** Retreives arbitrary pointers to structs stored by qof_book_set_data. */
+/** Retrieves arbitrary pointers to structs stored by qof_book_set_data. */
 gpointer qof_book_get_data (QofBook *book, const char *key);
 
 /** DOCUMENT ME! */
@@ -137,7 +144,7 @@
  *    anything about saving.  Its just that whenever data is modified,
  *    the 'dirty' flag is set.  This routine returns the value of the 
  *    'dirty' flag.  Its up to the backend to periodically reset this 
- *    flag, when it acutally does save the data.)
+ *    flag, when it actually does save the data.)
  */
 gboolean qof_book_not_saved (QofBook *book);
 
Index: src/engine/qof_book_merge.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/qof_book_merge.h,v
retrieving revision 1.2.2.1
diff -u -r1.2.2.1 qof_book_merge.h
--- src/engine/qof_book_merge.h	30 Dec 2004 21:37:22 -0000	1.2.2.1
+++ src/engine/qof_book_merge.h	31 Dec 2004 21:43:49 -0000
@@ -72,7 +72,7 @@
 
 
 #include <glib.h>
-#include "qof/gnc-engine-util.h"
+#include "gnc-engine-util.h"
 #include "qofbook.h"
 #include "qofclass.h"
 #include "qofobject.h"
Index: src/engine/qof.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/qof.h,v
retrieving revision 1.2.4.3
diff -u -r1.2.4.3 qof.h
--- src/engine/qof.h	7 Jul 2004 04:10:29 -0000	1.2.4.3
+++ src/engine/qof.h	31 Dec 2004 21:43:49 -0000
@@ -63,21 +63,21 @@
 */
 /** @} */
 
-#include "qof/gnc-date.h"
-#include "qof/gnc-engine-util.h"
-#include "qof/gnc-numeric.h"
-#include "qof/gnc-event.h"
-#include "qof/gnc-trace.h"
-#include "qof/guid.h"
-#include "qof/kvp_frame.h"
-#include "qof/qofbackend.h"
-#include "qof/qofid.h"
-#include "qof/qofbook.h"
-#include "qof/qofclass.h"
-#include "qof/qofobject.h"
-#include "qof/qofquery.h"
-#include "qof/qofquerycore.h"
-#include "qof/qofsession.h"
-#include "qof/qofsql.h"
+#include "gnc-date.h"
+#include "gnc-engine-util.h"
+#include "gnc-numeric.h"
+#include "gnc-event.h"
+#include "gnc-trace.h"
+#include "guid.h"
+#include "kvp_frame.h"
+#include "qofbackend.h"
+#include "qofid.h"
+#include "qofbook.h"
+#include "qofclass.h"
+#include "qofobject.h"
+#include "qofquery.h"
+#include "qofquerycore.h"
+#include "qofsession.h"
+#include "qofsql.h"
 
 #endif /* QOF_H_ */
Index: src/engine/qofid.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/qofid.h,v
retrieving revision 1.2.6.5
diff -u -r1.2.6.5 qofid.h
--- src/engine/qofid.h	25 Aug 2004 22:46:42 -0000	1.2.6.5
+++ src/engine/qofid.h	31 Dec 2004 21:43:49 -0000
@@ -121,7 +121,7 @@
 @param e_type QofIdType
 @param is_dirty gboolean
 @param hash_of_entities GHashTable
- at param data gpointer, place where object class can hang arbitrari data
+ at param data gpointer, place where object class can hang arbitrary data
 
 */
 typedef struct QofCollection_s QofCollection;
Index: src/engine/qofsql.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/qofsql.h,v
retrieving revision 1.4.2.2
diff -u -r1.4.2.2 qofsql.h
--- src/engine/qofsql.h	7 Jul 2004 04:10:30 -0000	1.4.2.2
+++ src/engine/qofsql.h	31 Dec 2004 21:43:49 -0000
@@ -32,9 +32,9 @@
 #define QOF_SQL_QUERY_H
 
 #include <glib.h>
-#include <qof/kvp_frame.h>
-#include <qof/qofbook.h>
-#include <qof/qofquery.h>
+#include <kvp_frame.h>
+#include <qofbook.h>
+#include <qofquery.h>
 
 /** @addtogroup SQL SQL Interface to Query
   @{ */


More information about the gnucash-patches mailing list