[Gnucash-changes] just a couple more documentation tweaks

Linas Vepstas linas at cvs.gnucash.org
Fri May 7 01:20:16 EDT 2004


Log Message:
-----------
just a couple more documentation tweaks

Modified Files:
--------------
    gnucash/src/engine:
        FreqSpec.h
        Group.h
        SchedXaction.h
        gnc-lot.h
        policy.h

Revision Data
-------------
Index: SchedXaction.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/SchedXaction.h,v
retrieving revision 1.33
retrieving revision 1.34
diff -Lsrc/engine/SchedXaction.h -Lsrc/engine/SchedXaction.h -u -r1.33 -r1.34
--- src/engine/SchedXaction.h
+++ src/engine/SchedXaction.h
@@ -21,7 +21,10 @@
  * @addtogroup Engine
  * @{ */
 /**
- * @addtogroup SchedXaction
+ * @addtogroup SchedXaction Scheduled/Periodic/Recurring Transactions
+   Scheduled Transactions provides a framework for remembering
+   information about a transactions that are set to occur in the 
+   future, either once or periodically.
  * @{ */
 /**
  * @file SchedXaction.h
Index: gnc-lot.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-lot.h,v
retrieving revision 1.20
retrieving revision 1.21
diff -Lsrc/engine/gnc-lot.h -Lsrc/engine/gnc-lot.h -u -r1.20 -r1.21
--- src/engine/gnc-lot.h
+++ src/engine/gnc-lot.h
@@ -20,7 +20,7 @@
 \********************************************************************/
 /** @addtogroup Engine
     @{ */
-/** @addtogroup Lot Lot: Core Function for AR/AP, Inventory, Stock Lots, Cap Gains
+/** @addtogroup Lot Lots: Core Function for AR/AP, Inventory, Stock Lots, Cap Gains
  * One often needs to know that the item 'bought' in one transaction
  * is the same one as the item 'sold' in a different transaction.
  * Lots are used to make this association.  One Lot holds all of the
Index: policy.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/policy.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -Lsrc/engine/policy.h -Lsrc/engine/policy.h -u -r1.5 -r1.6
--- src/engine/policy.h
+++ src/engine/policy.h
@@ -20,7 +20,7 @@
 \********************************************************************/
 /** @addtogroup Engine
     @{ */
-/** @addtogroup Policy Accounting Policy
+/** @addtogroup Policy Accounting Policy (FIFO/LIFO)
  *  This file implements Accounting Policy.  The Accounting Policy 
  *  determines how Splits are assigned to Lots.  The contents
  *  of a Lot determines the Gains on that Lot.  The default policy
Index: Group.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Group.h,v
retrieving revision 1.72
retrieving revision 1.73
diff -Lsrc/engine/Group.h -Lsrc/engine/Group.h -u -r1.72 -r1.73
--- src/engine/Group.h
+++ src/engine/Group.h
@@ -21,7 +21,7 @@
 \********************************************************************/
 /** @addtogroup Engine
     @{ */
-/** @addtogroup AccountGroup
+/** @addtogroup Group Account Heirarchy Tree
     Accounts are organized into a heirarchical tree.  The account
     group is the parent node that holds accounts.
     @{ */
Index: FreqSpec.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/FreqSpec.h,v
retrieving revision 1.19
retrieving revision 1.20
diff -Lsrc/engine/FreqSpec.h -Lsrc/engine/FreqSpec.h -u -r1.19 -r1.20
--- src/engine/FreqSpec.h
+++ src/engine/FreqSpec.h
@@ -19,7 +19,7 @@
 \********************************************************************/
 /** @addtogroup Engine
     @{ */
-/** @addtogroup FreqSpec  Frequency Specification
+/** @addtogroup FreqSpec Specifying Recurring Dates (Periods)
     @{ */
 /** @file FreqSpec.h
     @brief Period / Date Frequency Specification


More information about the Gnucash-changes mailing list