[lmi-commits] [lmi] master 8fa4ca4 03/10: Reformat and append to commentary

[Greg Chicares]

branch: master
commit 8fa4ca4169db88bf97645b2fb2fa0cf5020c5629
Author: Gregory W. Chicares <gchicares@sbcglobal.net>
Commit: Gregory W. Chicares <gchicares@sbcglobal.net>

    Reformat and append to commentary
---
 ihs_acctval.cpp | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/ihs_acctval.cpp b/ihs_acctval.cpp
index d2a6499..e8be4cf 100644
--- a/ihs_acctval.cpp
+++ b/ihs_acctval.cpp
@@ -963,19 +963,20 @@ void AccountValue::set_list_bill_premium()
         }
 }
 
+/// Calculate "modal minimum" premiums designed for group plans.
+///
+/// They are 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.
+///
+/// Some products apportion them explicitly between ee and er. For
+/// those that don't, convention deems the er to pay it all.
+///
+/// These values are calculated for all products, but probably should
+/// be restricted to group plans that actually use them on reports.
+
 void AccountValue::set_modal_min_premium()
 {
-    // These "modal minimum" premiums are designed for group plans.
-    // They are 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.
-    //
-    // Some products apportion them explicitly between ee and er. For
-    // those that don't, convention deems the er to pay it all.
-    //
-    // Most other yearly values are posted to InvariantValues() in
-    // FinalizeYear(), but it seems clearer to post these here where
-    // they're calculated along with 'MlyNoLapsePrem'.
     if(!SplitMinPrem)
         {
         auto const z = GetModalMinPrem