[lmi-commits] [4861] Improve documentation

[Greg Chicares]

Revision: 4861
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=4861
Author:   chicares
Date:     2010-04-25 21:29:35 +0000 (Sun, 25 Apr 2010)
Log Message:
-----------
Improve documentation

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

Modified: lmi/trunk/rounding_rules.cpp
===================================================================
--- lmi/trunk/rounding_rules.cpp        2010-04-24 23:50:16 UTC (rev 4860)
+++ lmi/trunk/rounding_rules.cpp        2010-04-25 21:29:35 UTC (rev 4861)
@@ -86,6 +86,15 @@
 {
 }
 
+/// Construct from filename.
+///
+/// Postcondition: rounding direction is appropriate for every rule
+/// used in 7702 and 7702A calculations.
+///
+/// RoundingDocument::WriteDocument() may (defectively) write files
+/// that violate this precondition, but this ctor prevents them from
+/// being used to produce illustrations.
+
 rounding_rules::rounding_rules(std::string const& filename)
 {
     Read(filename);