[Gnucash-changes] update documentation

[Linas Vepstas]

Log Message:
-----------
update documentation

Modified Files:
--------------
    gnucash/src/engine:
        policy.c
        policy.h

Revision Data
-------------
Index: policy.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/policy.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -Lsrc/engine/policy.c -Lsrc/engine/policy.c -u -r1.4 -r1.5
--- src/engine/policy.c
+++ src/engine/policy.c
@@ -22,7 +22,7 @@
 /** @file policy.c
  *  @breif Implement FIFO Accounting Policy.
  *  @author Created by Linas Vepstas August 2003
- *  @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
+ *  @author Copyright (c) 2003,2004 Linas Vepstas <linas at linas.org>
  *
  *  This file implements the FIFO Accounting Policy (and, in the 
  *  future, others as well).  The Accounting Polciy determines 
Index: policy.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/policy.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -Lsrc/engine/policy.h -Lsrc/engine/policy.h -u -r1.6 -r1.7
--- src/engine/policy.h
+++ src/engine/policy.h
@@ -31,7 +31,7 @@
 /** @file policy.h
  *  @brief Implement Accounting Policy.
  *  @author Created by Linas Vepstas August 2003
- *  @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
+ *  @author Copyright (c) 2003,2004 Linas Vepstas <linas at linas.org>
  */
 
 #ifndef XACC_POLICY_H 
@@ -39,10 +39,25 @@
 
 typedef struct gncpolicy_s GNCPolicy;
 
-/** First-in, First-out Policy */
+/** First-in, First-out Policy 
+ *  This policy will create FIFO Lots.  FIFO Lots have the following
+ *  properties:
+ *  -- The lot is started with the earliest posted split that isn't
+ *     a part of another lot already.
+ *  -- Splits are added to the lot in date order, with earliest splits
+ *     added first.
+ *  -- All splits in the lot share the same transaction currency as
+ *     the split that opened the lot.
+ */
 GNCPolicy *xaccGetFIFOPolicy (void); 
 
-/** Last-in, First-out Policy */
+/** Last-in, First-out Policy
+ *  This policy will create LIFO Lots.  LIFO Lots have the following
+ *  properties:
+ *  -- XXX  I think the implementation is broken right now.
+ *  -- All splits in the lot share the same transaction currency as
+ *     the split that opened the lot.
+ */
 GNCPolicy *xaccGetLIFOPolicy (void); 
 
 #endif /* XACC_POLICY_H */