[lmi-commits] [5347] Improve documentation, heralding changes to come

[Greg Chicares]

Revision: 5347
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5347
Author:   chicares
Date:     2012-01-08 02:30:37 +0000 (Sun, 08 Jan 2012)
Log Message:
-----------
Improve documentation, heralding changes to come

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

Modified: lmi/trunk/ihs_irc7702.cpp
===================================================================
--- lmi/trunk/ihs_irc7702.cpp   2012-01-07 13:26:22 UTC (rev 5346)
+++ lmi/trunk/ihs_irc7702.cpp   2012-01-08 02:30:37 UTC (rev 5347)
@@ -749,6 +749,13 @@
 
 //============================================================================
 // Designed for use by FindSpecAmt, which treats specamt and bftamt as equal.
+//
+// Soon this function will be eliminated. It is no longer needed by
+// FindSpecAmt. It is called only within the present TU, by the "full"
+// four-argument overload of Initialize7702() into which its useful
+// contents will soon be inserted inline. The zero-initializations
+// will not be so inserted: they are needless for FindSpecAmt, and
+// harmful otherwise because they cause inforce cases to be incorrect.
 void Irc7702::Initialize7702
     (double a_SpecAmt
     ) const