[Gnucash-changes] changes to make the documentation format nicely with docygen

Linas Vepstas linas at cvs.gnucash.org
Thu May 6 23:27:01 EDT 2004


Log Message:
-----------
changes to make the documentation format nicely with docygen

Modified Files:
--------------
    gnucash/src/engine:
        Scrub.h
        Scrub2.h
        Scrub3.h
        gnc-pricedb.h

Revision Data
-------------
Index: Scrub3.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Scrub3.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -Lsrc/engine/Scrub3.h -Lsrc/engine/Scrub3.h -u -r1.7 -r1.8
--- src/engine/Scrub3.h
+++ src/engine/Scrub3.h
@@ -21,20 +21,25 @@
 
 /** @addtogroup Engine
     @{ */
+/** @addtogroup Scrub
+    @{ */
+
 /** @file Scrub3.h
  *  @breif Hiogh-Level API for imposing Lot constraints
  *  @author Created by Linas Vepstas Sept 2003
  *  @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
- *
- * Provides the high-level API for checking and repairing ('scrubbing 
- * clean') the usage of Lots and Cap Gains transactions in stock and 
- * commodity accounts.  
  */
 #ifndef XACC_SCRUB3_H
 #define XACC_SCRUB3_H
 
 #include "gnc-engine.h"
 
+/** @name High-Level Lot Constraint
+ * Provides the high-level API for checking and repairing ('scrubbing 
+ * clean') the usage of Lots and Cap Gains transactions in stock and 
+ * commodity accounts.  
+ @{ */
+
 /** The xaccScrubLot() routine makes sure that the indicated lot is
  *    self-consistent and properly balanced, and fixes it if its not.
  *    This is an important routine to call if the amount of any split
@@ -69,5 +74,7 @@
 void xaccGroupScrubLots (AccountGroup *grp);
 void xaccAccountTreeScrubLots (Account *acc);
 
+/** @} */
 #endif /* XACC_SCRUB3_H */
+/** @} */
 /** @} */
Index: Scrub.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Scrub.h,v
retrieving revision 1.23
retrieving revision 1.24
diff -Lsrc/engine/Scrub.h -Lsrc/engine/Scrub.h -u -r1.23 -r1.24
--- src/engine/Scrub.h
+++ src/engine/Scrub.h
@@ -20,18 +20,31 @@
  *                                                                  *
 \********************************************************************/
 
+/** @addtogroup Engine
+    @{ */
+/** @addtogroup Scrub
+    Data scrubbing, repairing and forward migration routines.
+    These routines check and repair data, making sure that it
+    is in a format that the current version of the GnuCash
+    Engine likes.  These routines serve both to provide backwards
+    compatibility with older versions of GnuCash, and to fix
+    or at least paper over possible current problems.
+
+    It is typically expected that the scrub routines are run 
+    over newly imported data, as well as during data file input.
+    
+    In some cases, it is entirely appropriate to invoke these
+    routines from the GUI, to validate that the user input 
+    through the GUI is in a format that the system likes.  
+    This includes things like balancing individual transactions,
+    or assigning splits to lots, so that capital gains can be 
+    computed.
+    @{ */
+
 /** @file Scrub.h
- *
- * Provides a set of functions and utilities for checking and
- * repairing (formerly called 'scrubbing clean') single-entry accounts
- * so that they can be promoted into self-consistent, clean
- * double-entry accounts. Basically and additionally, this file
- * collects all functions that turn old (deprecated) data structures
- * into the current new data model.
- *
- * HISTORY:
- * Created by Linas Vepstas December 1998
- * Copyright (c) 1998-2000, 2003 Linas Vepstas <linas at linas.org>
+ *  @brief convert single-entry accounts to clean double-entry 
+ *  @author Created by Linas Vepstas December 1998
+ *  @author Copyright (c) 1998-2000, 2003 Linas Vepstas <linas at linas.org>
  */
 
 #ifndef XACC_SCRUB_H
@@ -40,27 +53,41 @@
 #include "Group.h"
 #include "gnc-engine.h"
 
-/** The ScrubOrphans() methods search for transacations that contain
- *    splits that do not have a parent account. These "orphaned splits"
- *    are placed into an "orphan account" which the user will have to 
- *    go into and clean up.  Kind of like the unix "Lost+Found" directory
- *    for orphaned inodes.
- *
- * The xaccTransScrubOrphans() method scrubs only the splits in the
+/** @name Double-Entry Scrubbing
+    Convert single-entry accounts to clean double-entry 
+
+    Provides a set of functions and utilities for checking and
+    repairing (formerly called 'scrubbing clean') single-entry accounts
+    so that they can be promoted into self-consistent, clean
+    double-entry accounts. Basically and additionally, this file
+    collects all functions that turn old (deprecated) data structures
+    into the current new data model.
+
+    The ScrubOrphans() methods search for transacations that contain
+    splits that do not have a parent account. These "orphaned splits"
+    are placed into an "orphan account" which the user will have to 
+    go into and clean up.  Kind of like the unix "Lost+Found" directory
+    for orphaned inodes.  
+    @{  */
+
+/** The xaccTransScrubOrphans() method scrubs only the splits in the
  *    given transaction. 
- *
- * The xaccAccountScrubOrphans() method performs this scrub only for the 
- *    indicated account, and not for any of its children.
- *
- * The xaccAccountTreeScrubOrphans() method performs this scrub for the 
- *    indicated account and its children.
- *
- * The xaccGroupScrubOrphans() method performs this scrub for the 
- *    child accounts of this group.
  */
 void xaccTransScrubOrphans (Transaction *trans);
+
+/** The xaccAccountScrubOrphans() method performs this scrub only for the 
+ *    indicated account, and not for any of its children.
+ */
 void xaccAccountScrubOrphans (Account *acc);
+
+/** The xaccAccountTreeScrubOrphans() method performs this scrub for the 
+ *    indicated account and its children.
+ */
 void xaccAccountTreeScrubOrphans (Account *acc);
+
+/** The xaccGroupScrubOrphans() method performs this scrub for the 
+ *    child accounts of this group. 
+ */
 void xaccGroupScrubOrphans (AccountGroup *grp);
 
 /** The xaccSplitScrub method ensures that if this split has the same
@@ -121,3 +148,6 @@
 void xaccGroupScrubQuoteSources (AccountGroup *group, gnc_commodity_table *table);
 
 #endif /* XACC_SCRUB_H */
+/** @} */
+/** @} */
+/** @} */
Index: gnc-pricedb.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-pricedb.h,v
retrieving revision 1.40
retrieving revision 1.41
diff -Lsrc/engine/gnc-pricedb.h -Lsrc/engine/gnc-pricedb.h -u -r1.40 -r1.41
--- src/engine/gnc-pricedb.h
+++ src/engine/gnc-pricedb.h
@@ -38,6 +38,7 @@
 /** @addtogroup Engine
     @{ */
 /** @addtogroup PriceDB  Price Database
+    @ingroup Engine
     The PriceDB is intended to be a database of price quotes, or more
     specifically, a database of GNCPrices.  For the time being, it is
     still a fairly simple database supporting only fairly simple
@@ -57,6 +58,7 @@
 */
 
 /** @addtogroup Price  Prices
+    @ingroup Engine
     Each price in the database represents an "instantaneous" quote for
     a given commodity with respect to another commodity.  For example,
     a given price might represent the value of LNUX in USD on
@@ -122,7 +124,7 @@
 
 /* ================================================================ */
 
-/** @addtogroup Price  Prices
+/** @addtogroup Price
  @{ */
 
 /** */
@@ -229,6 +231,7 @@
 
 gboolean gnc_price_list_equal(GList *prices1, GList *prices2);
 /**  @} */
+/**  @}  end of the Price doxygen group */
 
 /* ================================================================ */
 /** @addtogroup PriceDB
Index: Scrub2.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Scrub2.h,v
retrieving revision 1.15
retrieving revision 1.16
diff -Lsrc/engine/Scrub2.h -Lsrc/engine/Scrub2.h -u -r1.15 -r1.16
--- src/engine/Scrub2.h
+++ src/engine/Scrub2.h
@@ -21,11 +21,20 @@
 
 /** @addtogroup Engine
     @{ */
+/** @addtogroup Scrub  Data Validation
+    @{ */
 /** @file Scrub2.h
- *  @breif Utilities to Convert Stock Accounts to use Lots
+ *  @brief Utilities to Convert Stock Accounts to use Lots
  *  @author Created by Linas Vepstas March 2003
  *  @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
- *
+ */
+
+#ifndef XACC_SCRUB2_H
+#define XACC_SCRUB2_H
+
+#include "gnc-engine.h"
+
+/** @name Lot Management Routines
  * Provides the low-level API for checking and repairing ('scrubbing 
  * clean') the usage of Lots and lot balances in stock and commodity 
  * accounts.  Broken lots are repaired using a first-in, first-out 
@@ -35,12 +44,7 @@
  * only one particular task needed to clean up a Lot.  To clean up a 
  * Lot as a whole, you almost certainly want to use one of the
  * high-level API routines from the Scrub3.h file.
- */
-
-#ifndef XACC_SCRUB2_H
-#define XACC_SCRUB2_H
-
-#include "gnc-engine.h"
+ @{ */
 
 /** The xaccAccountAssignLots() routine will walk over all of
  *   the splits in an account, and make sure that each belongs
@@ -120,4 +124,6 @@
 gboolean xaccScrubMergeLotSubSplits (GNCLot *lot);
 
 #endif /* XACC_SCRUB2_H */
+/** @} */
+/** @} */
 /** @} */


More information about the Gnucash-changes mailing list