[lmi-commits] [6179] Improve documentation

[Greg Chicares]

Revision: 6179
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=6179
Author:   chicares
Date:     2015-05-02 00:25:44 +0000 (Sat, 02 May 2015)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ihs_acctval.cpp

Modified: lmi/trunk/ihs_acctval.cpp
===================================================================
--- lmi/trunk/ihs_acctval.cpp   2015-05-01 23:49:15 UTC (rev 6178)
+++ lmi/trunk/ihs_acctval.cpp   2015-05-02 00:25:44 UTC (rev 6179)
@@ -952,11 +952,14 @@
     ActualSpecAmt       = InvariantValues().SpecAmt[Year];
     TermSpecAmt         = InvariantValues().TermSpecAmt[Year];
 
+    // This "modal minimum" premium is designed for group plans. It is
+    // intended roughly to approximate the minimum payment (at a modal
+    // frequency chosen by the employer) necessary to prevent lapse if
+    // no other premium is paid.
+    //
     // Most other yearly values are posted to InvariantValues() in
     // FinalizeYear(), but it seems clearer to post this one here
     // where it's calculated along with 'MlyNoLapsePrem'.
-    // SOMEDAY !! It is arbitrarily assumed that the employer's mode
-    // governs; this could be made more flexible.
     InvariantValues().ModalMinimumPremium[Year] = GetModalMinPrem
         (Year
         ,InvariantValues().ErMode[Year].value()