[Gnucash-changes] more doxygen docuemtnation updates

Linas Vepstas linas at cvs.gnucash.org
Fri May 7 00:54:21 EDT 2004


Log Message:
-----------
more doxygen docuemtnation updates

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

Revision Data
-------------
Index: gnc-lot.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-lot.h,v
retrieving revision 1.19
retrieving revision 1.20
diff -Lsrc/engine/gnc-lot.h -Lsrc/engine/gnc-lot.h -u -r1.19 -r1.20
--- src/engine/gnc-lot.h
+++ src/engine/gnc-lot.h
@@ -18,10 +18,9 @@
  * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
  * Boston, MA  02111-1307,  USA       gnu at gnu.org                   *
 \********************************************************************/
-
-
-/** @file gnc-lot.h
- * 
+/** @addtogroup Engine
+    @{ */
+/** @addtogroup Lot Lot: 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
@@ -34,9 +33,12 @@
  * depreciation and stock market investment gains. See the file
  * src/doc/lots.txt for implmentation overview.
  *
- * HISTORY:
- * Created by Linas Vepstas May 2002
- * Copyright (c) 2002,2003 Linas Vepstas <linas at linas.org>
+ @{ */
+
+/** @file gnc-lot.h
+ * 
+ * @author Created by Linas Vepstas May 2002
+ * @author Copyright (c) 2002,2003 Linas Vepstas <linas at linas.org>
  */
 
 #ifndef GNC_LOT_H
@@ -120,3 +122,5 @@
 #define LOT_BALANCE	"balance"
 
 #endif /* GNC_LOT_H */
+/** @} */
+/** @} */
Index: policy.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/policy.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -Lsrc/engine/policy.h -Lsrc/engine/policy.h -u -r1.4 -r1.5
--- src/engine/policy.h
+++ src/engine/policy.h
@@ -22,10 +22,11 @@
     @{ */
 /** @addtogroup Policy Accounting Policy
  *  This file implements Accounting Policy.  The Accounting Policy 
- *  determines how splits are assigned to lots.  The default policy
+ *  determines how Splits are assigned to Lots.  The contents
+ *  of a Lot determines the Gains on that Lot.  The default policy
  *  is the FIFO policy: the first thing bought is also the first 
- *  thing sold. 
-    @{ */
+ *  thing sold.  
+ @{ */
 
 /** @file policy.h
  *  @brief Implement Accounting Policy.


More information about the Gnucash-changes mailing list