[lmi-commits] [6396] Improve documentation

[Greg Chicares]

Revision: 6396
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=6396
Author:   chicares
Date:     2015-11-07 13:47:45 +0000 (Sat, 07 Nov 2015)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/input_xml_io.cpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2015-11-07 13:46:19 UTC (rev 6395)
+++ lmi/trunk/ChangeLog 2015-11-07 13:47:45 UTC (rev 6396)
@@ -37419,3 +37419,40 @@
 reinitialized where needed, causing their values to become enormous
 after multiple solve iterations.
 
+20151107T1322Z <address@hidden> [471]
+
+  input_harmonization.cpp
+Improve documentation.
+
+20151107T1341Z <address@hidden> [471]
+
+  gpt_input.cpp
+  illustrator.cpp
+  mec_input.cpp
+Regularize idioms to distinguish new business from inforce.
+
+20151107T1342Z <address@hidden> [471]
+
+  basicvalues.cpp
+  ihs_basicval.cpp
+Regularize idioms to distinguish new business from inforce.
+
+20151107T1344Z <address@hidden> [471]
+
+  ihs_acctval.cpp
+  ihs_avstrtgy.cpp
+  ihs_server7702.cpp
+  ledger_invariant.cpp
+Regularize idioms to distinguish new business from inforce.
+
+20151107T1346Z <address@hidden> [470]
+
+  ihs_irc7702.cpp
+  ihs_irc7702a.cpp
+Plan to regularize idioms to distinguish new business from inforce.
+
+20151107T1347Z <address@hidden> [470]
+
+  input_xml_io.cpp
+Improve documentation.
+

Modified: lmi/trunk/input_xml_io.cpp
===================================================================
--- lmi/trunk/input_xml_io.cpp  2015-11-07 13:46:19 UTC (rev 6395)
+++ lmi/trunk/input_xml_io.cpp  2015-11-07 13:47:45 UTC (rev 6396)
@@ -577,6 +577,9 @@
         // function needs them now. This requires version 5, which
         // introduced 'InforceAsOfDate'; no "deficient" extract
         // should have an earlier version.
+        //
+        // set_inforce_durations_from_dates() does the same and more;
+        // but, because it does more, it can't simply be called here.
         if(deficient_extract && EffectiveDate.value() != 
InforceAsOfDate.value())
             {
             LMI_ASSERT(4 < file_version);
@@ -590,6 +593,10 @@
         // Requiring 'deficient_extract' here wouldn't be right,
         // because an extract file that has been modified and saved
         // is no longer detectably "deficient".
+        //
+        // This idiom for distinguishing inforce from new business is
+        // avoided in new code, but retained in backward-compatibility
+        // code that, by its nature, should rarely be modernized.
         if(0 != InforceYear || 0 != InforceMonth)
             {
             if