[lmi-commits] [6309] Improve documentation

[Greg Chicares]

Revision: 6309
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=6309
Author:   chicares
Date:     2015-09-26 19:16:23 +0000 (Sat, 26 Sep 2015)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/input_harmonization.cpp
    lmi/trunk/ledger.hpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2015-09-26 19:15:20 UTC (rev 6308)
+++ lmi/trunk/ChangeLog 2015-09-26 19:16:23 UTC (rev 6309)
@@ -36950,3 +36950,14 @@
   ledger_xsl.cpp
 Effect regulatory prohibitions.
 
+20150926T1915Z <address@hidden> [474]
+
+  ledger.cpp
+Assert trivial-accessor preconditions.
+
+20150926T1916Z <address@hidden> [474]
+
+  input_harmonization.cpp
+  ledger.hpp
+Improve documentation.
+

Modified: lmi/trunk/input_harmonization.cpp
===================================================================
--- lmi/trunk/input_harmonization.cpp   2015-09-26 19:15:20 UTC (rev 6308)
+++ lmi/trunk/input_harmonization.cpp   2015-09-26 19:16:23 UTC (rev 6309)
@@ -1070,6 +1070,11 @@
     SolveEndTime    = issue_age() + SolveEndYear   .value();
 }
 
+/// Determine number of full years and months since issue.
+///
+/// If the contract has been in force for a nonzero period less than
+/// one full month, then InforceYear and InforceMonth are both zero.
+
 void Input::set_inforce_durations_from_dates()
 {
     std::pair<int,int> ym0 = years_and_months_since

Modified: lmi/trunk/ledger.hpp
===================================================================
--- lmi/trunk/ledger.hpp        2015-09-26 19:15:20 UTC (rev 6308)
+++ lmi/trunk/ledger.hpp        2015-09-26 19:16:23 UTC (rev 6309)
@@ -117,6 +117,15 @@
     LedgerVariant const& GetOneVariantLedger(mcenum_run_basis) const;
     void SetRunBases(int length);
 
+    // These members store ctor arguments whose values cannot be set
+    // otherwise. The rationale for storing them here (rather than in
+    // class LedgerInvariant, e.g.) is that they are not data from
+    // which reports are generated--rather, they govern how reports
+    // are generated, and which reports are permitted.
+    //
+    // Naming: "is_composite_" because "composite" could be taken as a
+    // noun, suggesting a composite ledger; "nonillustrated_" without
+    // "is_" because it's unambiguously adjectival.
     mcenum_ledger_type ledger_type_   ;
     bool               nonillustrated_;
     bool               no_can_issue_  ;