[lmi-commits] [5036] Improve documentation

[Greg Chicares]

Revision: 5036
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5036
Author:   chicares
Date:     2010-07-18 16:27:17 +0000 (Sun, 18 Jul 2010)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/dbnames.xpp
    lmi/trunk/xml_serializable.tpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2010-07-18 14:59:17 UTC (rev 5035)
+++ lmi/trunk/ChangeLog 2010-07-18 16:27:17 UTC (rev 5036)
@@ -26333,8 +26333,25 @@
   mvc_controller.cpp
 Correct a typographical error in a comment.
 
- <address@hidden> [693]
+20100717T0838Z <address@hidden> [693]
 
   version.hpp
 Mark release candidate.
 
+20100718T1459Z <address@hidden> [693]
+
+  GNUmakefile
+  README.auto
+  main_cgi.cpp
+  my_test_coding_rules.cpp
+  objects.make
+  test_coding_rules_test.sh
+  text_view.hpp
+Reflect conversion from cvs to svn.
+
+20100718T1627Z <address@hidden> [693]
+
+  dbnames.xpp
+  xml_serializable.tpp
+Improve documentation.
+

Modified: lmi/trunk/dbnames.xpp
===================================================================
--- lmi/trunk/dbnames.xpp       2010-07-18 14:59:17 UTC (rev 5035)
+++ lmi/trunk/dbnames.xpp       2010-07-18 16:27:17 UTC (rev 5036)
@@ -137,13 +137,13 @@
 {DB_PremTaxLoad,DB_Topic_DacAndPremiumTax,"PremTaxLoad","Scalar premium load 
due to premium tax",}, \
 {DB_WaivePremTaxInt1035,DB_Topic_DacAndPremiumTax,"WaivePremTaxInt1035","Waive 
premium tax charge on internal 1035 exchanges: 0=no, 1=yes",}, \
 {DB_PremTaxRetalLimit,DB_Topic_DacAndPremiumTax,"PremTaxRetalLimit","Premium 
tax: first-year premium threshold to waive retaliation",}, \
-{DB_PremTaxTierGroup,DB_Topic_DacAndPremiumTax,"PremTaxTierGroup","Apply 
tiered premium tax to all contracts in a group aggregated together: 0=no, 
1=yes",}, \
-{DB_PremTaxTierPeriod,DB_Topic_DacAndPremiumTax,"PremTaxTierPeriod","Apply 
tiered premium tax to premiums aggregated by: 0=policy year, 1=calendar 
year",}, \
-{DB_PremTaxTierNonDecr,DB_Topic_DacAndPremiumTax,"PremTaxTierNonDecr","Tiered 
premium tax effective rate constrained not to decrease from one year to the 
next: 0=no, 1=yes",}, \
+{DB_PremTaxTierGroup,DB_Topic_DacAndPremiumTax,"PremTaxTierGroup","Apply 
tiered premium tax to all contracts in a group aggregated together: 0=no, 1=yes 
[not supported yet]",}, \
+{DB_PremTaxTierPeriod,DB_Topic_DacAndPremiumTax,"PremTaxTierPeriod","Apply 
tiered premium tax to premiums aggregated by: 0=policy year, 1=calendar year 
[not supported yet]",}, \
+{DB_PremTaxTierNonDecr,DB_Topic_DacAndPremiumTax,"PremTaxTierNonDecr","Tiered 
premium tax effective rate constrained not to decrease from one year to the 
next: 0=no, 1=yes [not supported yet]",}, \
 {DB_PremTaxAmortPeriod,DB_Topic_DacAndPremiumTax,"PremTaxAmortPeriod","Premium 
tax amortization period in years",}, \
 
{DB_PremTaxAmortIntRate,DB_Topic_DacAndPremiumTax,"PremTaxAmortIntRate","Premium
 tax amortization annual effective interest rate",}, \
 {DB_PremTaxRate,DB_Topic_DacAndPremiumTax,"PremTaxRate","Scalar premium tax 
rate paid by insurance company--distinct from premium load due to premium 
tax",}, \
-{DB_PremTaxState,DB_Topic_DacAndPremiumTax,"PremTaxState","State that 
determines premium tax rate: 0=insured state, 1=corporation state",}, \
+{DB_PremTaxState,DB_Topic_DacAndPremiumTax,"PremTaxState","[Obsolete--included 
only for backward compatibility] State that formerly determined premium tax 
rate: 0=insured state, 1=corporation state",}, \
 {DB_PremTaxTable,DB_Topic_DacAndPremiumTax,"PremTaxTable","[not yet 
implemented--use PremTaxLoad instead]",}, \
 {DB_Topic_SurrenderCharges,DB_FIRST,"Surrender charges","Surrender-charge 
rates and parameters",}, \
 
{DB_SurrChgAcctValMult,DB_Topic_SurrenderCharges,"SurrChgAcctValMult","Multiple 
of account value for formulaic surrender charges",}, \

Modified: lmi/trunk/xml_serializable.tpp
===================================================================
--- lmi/trunk/xml_serializable.tpp      2010-07-18 14:59:17 UTC (rev 5035)
+++ lmi/trunk/xml_serializable.tpp      2010-07-18 16:27:17 UTC (rev 5036)
@@ -367,10 +367,10 @@
 /// It would be reasonable to override this function to copy the
 /// issue-date value to a new effective date element.
 ///
-/// The 'residuary_names' argument contains all element tags actually
-/// found in the xml being read that have not yet been processed. This
-/// is useful for verifying that an element expected not to be present
-/// is actually not specified.
+/// The 'residuary_names' argument contains all "ascribed" class
+/// member names that did not occur as element tags in the xml file
+/// being read. This is useful for verifying that an element expected
+/// to be absent actually was absent.
 ///
 /// The 'detritus_map' argument contains names and values of all tags
 /// that have already been processed if they were marked as detritus: