[lmi-commits] [lmi] valyuta/002 e0c5136 45/65: improve documentation

[Greg Chicares]

branch: valyuta/002
commit e0c513600b6ed1db5d0e21ef8a4b3807e95404fa
Author: Gregory W. Chicares <gchicares@sbcglobal.net>
Commit: Gregory W. Chicares <gchicares@sbcglobal.net>

    improve documentation
---
 ihs_avmly.cpp | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/ihs_avmly.cpp b/ihs_avmly.cpp
index 2163af3..58aecdf 100644
--- a/ihs_avmly.cpp
+++ b/ihs_avmly.cpp
@@ -1295,10 +1295,14 @@ void AccountValue::TxAscertainDesiredPayment()
     LMI_ASSERT(materially_equal(GrossPmts[Month], EeGrossPmts[Month] + 
ErGrossPmts[Month]));
 }
 
-//============================================================================
-// TAXATION !! Should this be called for gpt? or, if it's called,
-// should it assert that it has no effect?
-//void AccountValue::TxLimitPayment(currency a_maxpmt)
+/// Limit payment (e.g., to the non-MEC maximum).
+///
+/// The limit argument is of type double because the taxation code may
+/// return DBL_MAX.
+///
+/// TAXATION !! Should this be called for gpt? or, if it's called,
+/// should it assert that it has no effect?
+
 void AccountValue::TxLimitPayment(double a_maxpmt)
 {
 // Subtract premium load from gross premium yielding net premium.