[Gnucash-changes] r13569 - gnucash/trunk/lib/libqof/qof - Doxygen tweak

[Neil Williams]

Author: codehelp
Date: 2006-03-09 12:03:57 -0500 (Thu, 09 Mar 2006)
New Revision: 13569
Trac: http://svn.gnucash.org/trac/changeset/13569

Modified:
   gnucash/trunk/lib/libqof/qof/qofevent.h
Log:
Doxygen tweak

Modified: gnucash/trunk/lib/libqof/qof/qofevent.h
===================================================================
--- gnucash/trunk/lib/libqof/qof/qofevent.h	2006-03-09 17:03:40 UTC (rev 13568)
+++ gnucash/trunk/lib/libqof/qof/qofevent.h	2006-03-09 17:03:57 UTC (rev 13569)
@@ -46,10 +46,10 @@
 of application events without interfering with any new
 events added within QOF.
 
-/verbatim
+\verbatim
 #define APP_EVENT_A QOF_MAKE_EVENT(QOF_EVENT_BASE+0)
 #define APP_EVENT_B QOF_MAKE_EVENT(QOF_EVENT_BASE+1)
-/endverbatim
+\endverbatim
 */
 #define QOF_MAKE_EVENT(x)    (1<<(x))
 
@@ -61,6 +61,9 @@
 
 These defaults merely replicate previous behaviour,
 any process can define their own events. 
+
+\note events 5, 6, and 7 are "undefined" as of v0.6.3
+for future libqof1 or libqof2 usage.
 */
 #define QOF_EVENT_NONE     (0)
 #define QOF_EVENT_CREATE   QOF_MAKE_EVENT(0)
@@ -70,7 +73,6 @@
 #define QOF_EVENT_REMOVE   QOF_MAKE_EVENT(4)
 #define QOF_EVENT__LAST    QOF_MAKE_EVENT(QOF_EVENT_BASE-1)
 #define QOF_EVENT_ALL      (0xff)
-/* Note that events 5, 6, and 7 are "undefined" as of 2006-03-08 */
 
 /** \brief Handler invoked when an event is generated.
  *
@@ -102,11 +104,11 @@
 
    Certain default events are used by QOF:
 
--QOF_EVENT_DEFAULT_CREATE events should be generated after the object
+- QOF_EVENT_DEFAULT_CREATE events should be generated after the object
     has been created and registered in the engine entity table.
--QOF_EVENT_DEFAULT_MODIFY events should be generated whenever any data
+- QOF_EVENT_DEFAULT_MODIFY events should be generated whenever any data
      member or submember (i.e., splits) is changed.
--QOF_EVENT_DEFAULT_DESTROY events should be called before the object
+- QOF_EVENT_DEFAULT_DESTROY events should be called before the object
      has been destroyed or removed from the entity table.
 
    Any other events are entirely the concern of the application.