[lmi-commits] [6135] Improve documentation

[Greg Chicares]

Revision: 6135
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=6135
Author:   chicares
Date:     2015-03-16 22:35:38 +0000 (Mon, 16 Mar 2015)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/GNUmakefile
    lmi/trunk/ihs_acctval.cpp
    lmi/trunk/illustration_document.cpp
    lmi/trunk/premium_tax.cpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2015-03-16 04:30:20 UTC (rev 6134)
+++ lmi/trunk/ChangeLog 2015-03-16 22:35:38 UTC (rev 6135)
@@ -35833,3 +35833,11 @@
   types.xsd
 Update input schemata.
 
+20150316T2235Z <address@hidden> [516]
+
+  GNUmakefile
+  ihs_acctval.cpp
+  illustration_document.cpp
+  premium_tax.cpp
+Improve documentation.
+

Modified: lmi/trunk/GNUmakefile
===================================================================
--- lmi/trunk/GNUmakefile       2015-03-16 04:30:20 UTC (rev 6134)
+++ lmi/trunk/GNUmakefile       2015-03-16 22:35:38 UTC (rev 6135)
@@ -475,6 +475,10 @@
        svn co svn://svn.savannah.nongnu.org/lmi/lmi/trunk lmi; \
        svn co svn://svn.savannah.nongnu.org/lmi/skeleton/trunk skeleton; \
 
+# SOMEDAY !! Add build types for gcov (-fprofile-arcs -ftest-coverage)
+# and for gprof. See:
+#   http://lists.nongnu.org/archive/html/lmi/2014-10/msg00115.html
+
 .PHONY: test_various_build_types
 test_various_build_types: source_clean
        -$(MAKE) all test build_type=mpatrol

Modified: lmi/trunk/ihs_acctval.cpp
===================================================================
--- lmi/trunk/ihs_acctval.cpp   2015-03-16 04:30:20 UTC (rev 6134)
+++ lmi/trunk/ihs_acctval.cpp   2015-03-16 22:35:38 UTC (rev 6135)
@@ -457,7 +457,7 @@
             }
         }
 
-    // INPUT !! Need inforce tgtprem.
+    // TAXATION !! Input::InforceAnnualTargetPremium should be used here.
     double annual_target_premium = GetModalTgtPrem
         (0
         ,mce_annual

Modified: lmi/trunk/illustration_document.cpp
===================================================================
--- lmi/trunk/illustration_document.cpp 2015-03-16 04:30:20 UTC (rev 6134)
+++ lmi/trunk/illustration_document.cpp 2015-03-16 22:35:38 UTC (rev 6135)
@@ -139,6 +139,8 @@
 bool IllustrationDocument::OnNewDocument()
 {
     Modify(true);
+// SOMEDAY !! Search for "SetDocumentSaved" on the mailing list and
+// resolve the issues discussed there.
     SetDocumentSaved(false);
 
 #if wxCHECK_VERSION(2,8,8)

Modified: lmi/trunk/premium_tax.cpp
===================================================================
--- lmi/trunk/premium_tax.cpp   2015-03-16 04:30:20 UTC (rev 6134)
+++ lmi/trunk/premium_tax.cpp   2015-03-16 22:35:38 UTC (rev 6135)
@@ -270,8 +270,8 @@
 /// TODO ?? This is incorrect for inforce. Suppose the tax state has
 /// a tiered rate with a breakpoint that has already been met for an
 /// off-anniversary inforce illustration. Any further payment in the
-/// same year should be taxed at a lower rate. INPUT !! YTD taxable
-/// premium needs to be passed from the admin system; it is not
+/// same year should be taxed at a lower rate. YTD taxable premium is
+/// now available as Input::InforceYtdTaxablePremium; it is not
 /// necessary to pass the other variables, because they can be
 /// calculated here.