[lmi-commits] [lmi] master ced2b54 5/6: Improve documentation

[Greg Chicares]

branch: master
commit ced2b54d0b0140e836e196949f7d0dc635c1dacb
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Improve documentation
---
 ihs_acctval.cpp | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/ihs_acctval.cpp b/ihs_acctval.cpp
index 16fe9c8..0b016ab 100644
--- a/ihs_acctval.cpp
+++ b/ihs_acctval.cpp
@@ -1188,6 +1188,13 @@ void AccountValue::set_list_bill_premium()
 /// The "cash value enhancement" components should be implemented as
 /// such, rather than as negative surrender charges.
 ///
+/// This ought to be called annually, OAOO, at the top level, and
+/// stored in the variant or invariant ledger depending on whether
+/// surrender charges are to vary by basis. All other direct calls
+/// to this function should be replaced by constant values looked up
+/// in a ledger, or perhaps in SurrChg_ if that vector is ever given
+/// any nonzero value.
+///
 /// SOMEDAY !! Table support and UL model reg formulas should be added.
 
 double AccountValue::SurrChg()