[Gnucash-changes] r11851 - gnucash/trunk/doc - converting RAW-NOTES to Doxygen documentation

[Neil Williams]

Author: codehelp
Date: 2005-11-06 08:12:06 -0500 (Sun, 06 Nov 2005)
New Revision: 11851

Modified:
   gnucash/trunk/doc/RAW-NOTES
Log:
converting RAW-NOTES to Doxygen documentation

Modified: gnucash/trunk/doc/RAW-NOTES
===================================================================
--- gnucash/trunk/doc/RAW-NOTES	2005-11-06 04:08:22 UTC (rev 11850)
+++ gnucash/trunk/doc/RAW-NOTES	2005-11-06 13:12:06 UTC (rev 11851)
@@ -1,22 +1,17 @@
-RAW NOTES
----------
-These need to be beautified into real documentation.
+/** \page rawnotes Miscellaneous Notes.
 
+\section stock splits & cost basis
 
-=========================================================================
-
-stock splits & cost basis
--------------------------
 OK, here's a question for accountants of various different countries:
-What's the cost basis for a stock split? Does the rest of teh world do
+What's the cost basis for a stock split? Does the rest of the world do
 it the way the US does it?
 
-For eaxmple:
+For example:
 In Jan 1995 buy 100s stock for $10 per share
 In July 1997 split 2-for-1
 In August 1997, sell 120s stock for $30 per share
 
-I beleive the following is correct for the united states:
+I believe the following is correct for the united states:
 My cost basis is $5 per share, and my gains of $25x120 are taxable
 as long-term cap gains.
 
@@ -25,7 +20,8 @@
 --- would there ever be a case where the gains would be considered
     'short-term' for some portion of the total?
 
-----------------------------------------------
+\subsection Spin off stocks.
+
 OK, that was easy. Here's the harder one: a spin-off:
 
 For example:
@@ -42,13 +38,11 @@
 Note there is still an invarient:
 (old price of A) * 20s == (new price of A) *20s + (price of B) * 1s
 
+\section Depreciation, Sinking Funds ...
 
-=========================================================================
-
-Depreciation, Sinking Funds ...
-
 On 21 Apr 2000 20:39:43 CDT, the world broke into rejoicing as
 John Hasler <john at dhh.gt.org>  said:
+\verbatim
 > Lauren writes:
 > > I'm not familliar with sinking funds, but what makes them a bit different
 > > from a book entry like depreciation (also somewhat virtual) is that they
@@ -66,6 +60,7 @@
 > When you transfer funds to your "Savings Goal" or your "Sinking Fund" you
 > are transferring funds from one asset account to another.  Just credit
 > 'Cash' and debit 'Savings Goals:Honeymoon'.
+\endvarbatim
 
 The problem with proceeding to credit Cash and debit "Savings Goal" is
 that this invalidates any reconciliation of Cash.  I'd be game to do
@@ -75,25 +70,13 @@
 For different purposes, I will want both to consider and ignore these
 "funds reservations."
 
-a) When making up a _budget_, I care about what funds are reserved for
+- When making up a <b>budget</b>, I care about what funds are reserved for
    particular purposes.
 
-b) When trying to figure out if my bank account is going to be
-overdrawn,
-   "reserved" funds are _irrelevant._
+- When trying to figure out if my bank account is going to be
+overdrawn, "reserved" funds are <b>irrelevant.</b>
 
 I would thus suggest that the "gentle user" use the budget system to
 manage this rather than having these be "true" transactions in the
 ledger.
-
-======================================================================
-document the 'security' and the 'price quotes' fields.
-fix em up too ...
-
-======================================================================
-Instructins for how to do QIF import should be reviewed/redone
-======================================================================
-typing + in the check-number field uses the next check number ..
-
-
-xxx
+*/