misc cleanup

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@9167 57a11ea4-9604-0410-9ed3-97b8803252fd

src/engine/gnc-lot.c

@@ -28,9 +28,14 @@
  * inventory lots, and stock market investment lots.  See the file
  * src/doc/lots.txt for implmentation overview.
  *
+ * XXX Lots are not currently treated in a correct transactional
+ * manner.  There's no dirty flag, and, at this time, the backend
+ * is not signalled about the fact that a lot has changed.  This
+ * is true both in the Scrub2.c and in src/gnome/lot-viewer.c
+ *
  * HISTORY:
  * Created by Linas Vepstas May 2002
- * Copyright (c) 2002.2003 Linas Vepstas <linas@linas.org>
+ * Copyright (c) 2002,2003 Linas Vepstas <linas@linas.org>
  */
 
 #include "Account.h"
@@ -55,7 +60,7 @@ static void
 gnc_lot_init (GNCLot *lot, QofBook *book)
 {
    ENTER ("(lot=%p, book=%p)", lot, book);
-   lot->kvp_data = kvp_frame_new();;
+   lot->kvp_data = kvp_frame_new();
    lot->account = NULL;
    lot->splits = NULL;
    lot->is_closed = -1;

src/engine/kvp_doc.txt

@@ -30,7 +30,7 @@ Use: The use to which the key will be put. Include any requirements
 
 Example:
 
-Name: my-favorite-thing
+Name: /my-favorite-thing
 Type: string
 Entities: Account
 Use:  xaccGetMyFavoriteThing(), xaccSetMyFavoriteThing()
@@ -249,16 +249,22 @@ Entities: Account
 Use: When a lot in this account is double-balanced, this key specifies
      the account to which realized gains are to be posted.
 
+Name: /lot-mgmt/next-id
+Type: int64
+Entities: Account
+Use: The next unused lot id number, used to autogenerate
+     a lot title.
+
 
 -----------------------
 
-Name: notes
+Name: /notes
 Type: string
 Entities: Account, Lot, Transaction
-Use: xaccAccountGetNotes(), xaccAccountSetNotes(),
-     xaccTransGetNotes(), xaccTransSetNotes(),
-     gnc_lot_get_notes(), gnc_lot_set_notes()
-     Store the 'Notes' string.
+Use: A user-suplied 'Notes' text field.  The user can set this to 
+     any value and change it at any time for any reason.
+     Accessors: xaccAccountGetNotes(), xaccAccountSetNotes(),
+     xaccTransGetNotes(), xaccTransSetNotes()
 
 Name: old-currency
 Type: string
@@ -302,7 +308,7 @@ Use: This holds the old security scu. This may be deleted at
 
 -----------------------
 
-Name: /reconcile-info
+Name: /reconcile-info/
 Type: frame
 Entities: Account
 Use: store reconcile information about accounts
@@ -382,6 +388,12 @@ Type: gint64
 Entities: Account
 Use: A boolean flag indicated whether the Account is tax-related.
 
+Name: /title
+Type: string
+Entities: Lot
+Use:  A user-suplied title for the lot.  The user can set this to 
+      any value and change it at any time for any reason.
+
 Name: trans-date-due
 Type: Timespec
 Entities: Transaction