[Gnucash-changes] Working on the doxygen documentation: fix some typos, add a missed file,

[Linas Vepstas]

Log Message:
-----------
Working on the doxygen documentation:
fix some typos, add a missed file,

Modified Files:
--------------
    gnucash/src/engine:
        Period.h
        Scrub3.h
        cap-gains.h
        gnc-pricedb.h
        policy.h

Revision Data
-------------
Index: Scrub3.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Scrub3.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -Lsrc/engine/Scrub3.h -Lsrc/engine/Scrub3.h -u -r1.8 -r1.9
--- src/engine/Scrub3.h
+++ src/engine/Scrub3.h
@@ -25,7 +25,7 @@
     @{ */
 
 /** @file Scrub3.h
- *  @breif Hiogh-Level API for imposing Lot constraints
+ *  @brief Hiogh-Level API for imposing Lot constraints
  *  @author Created by Linas Vepstas Sept 2003
  *  @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
  */
Index: Period.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Period.h,v
retrieving revision 1.19
retrieving revision 1.20
diff -Lsrc/engine/Period.h -Lsrc/engine/Period.h -u -r1.19 -r1.20
--- src/engine/Period.h
+++ src/engine/Period.h
@@ -25,7 +25,7 @@
     in greater detail in the file "src/doc/books.txt"
     @{ */
 /** @file Period.h
- *  @breif Implement accounting periods, as per design in src/doc/books.txt
+ *  @brief Implement accounting periods, as per design in src/doc/books.txt
  *  @author Copyright (c) 2001,2003 Linas Vepstas <linas at linas.org>
  */
 
Index: policy.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/policy.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -Lsrc/engine/policy.h -Lsrc/engine/policy.h -u -r1.3 -r1.4
--- src/engine/policy.h
+++ src/engine/policy.h
@@ -18,16 +18,19 @@
  * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
  * Boston, MA  02111-1307,  USA       gnu at gnu.org                   *
 \********************************************************************/
-
-/** @file policy.h
- *  @breif Implement Accounting Policy.
- *  @author Created by Linas Vepstas August 2003
- *  @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
- *
+/** @addtogroup Engine
+    @{ */
+/** @addtogroup Policy Accounting Policy
  *  This file implements Accounting Policy.  The Accounting Policy 
  *  determines how splits are assigned to lots.  The default policy
  *  is the FIFO policy: the first thing bought is also the first 
  *  thing sold. 
+    @{ */
+
+/** @file policy.h
+ *  @brief Implement Accounting Policy.
+ *  @author Created by Linas Vepstas August 2003
+ *  @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
  */
 
 #ifndef XACC_POLICY_H 
@@ -35,7 +38,12 @@
 
 typedef struct gncpolicy_s GNCPolicy;
 
+/** First-in, First-out Policy */
 GNCPolicy *xaccGetFIFOPolicy (void); 
+
+/** Last-in, First-out Policy */
 GNCPolicy *xaccGetLIFOPolicy (void); 
 
 #endif /* XACC_POLICY_H */
+/** @} */
+/** @} */
Index: gnc-pricedb.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-pricedb.h,v
retrieving revision 1.41
retrieving revision 1.42
diff -Lsrc/engine/gnc-pricedb.h -Lsrc/engine/gnc-pricedb.h -u -r1.41 -r1.42
--- src/engine/gnc-pricedb.h
+++ src/engine/gnc-pricedb.h
@@ -34,6 +34,15 @@
 #include "qofid.h"
 #include "qofinstance.h"
 
+/** @addtogroup PriceDB
+    @{ */
+/** @file gnc-pricedb.h
+    @author Copyright (C) 2001 Rob Browning
+    @author Copyright (C) 2001,2003 Linas Vepstas <linas at linas.org>
+    @brief a simple price database for gnucash
+*/
+/** @} */
+
 
 /** @addtogroup Engine
     @{ */
@@ -116,12 +125,6 @@
       given.  It is assumed that commodities are a global resource and
       are pointer unique.
    */
-/** @file gnc-pricedb.h
-    @author Copyright (C) 2001 Rob Browning
-    @author Copyright (C) 2001,2003 Linas Vepstas <linas at linas.org>
-    @brief a simple price database for gnucash
-*/
-
 /* ================================================================ */
 
 /** @addtogroup Price
Index: cap-gains.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/cap-gains.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -Lsrc/engine/cap-gains.h -Lsrc/engine/cap-gains.h -u -r1.7 -r1.8
--- src/engine/cap-gains.h
+++ src/engine/cap-gains.h
@@ -38,7 +38,7 @@
  *     @{ */
 
 /** @file cap-gains.h
- *  @breif Utilities to Automatically Compute Capital Gains/Losses.
+ *  @brief Utilities to Automatically Compute Capital Gains/Losses.
  *  @author Created by Linas Vepstas August 2003
  *  @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
  */