[lmi-commits] [lmi] master 34e9f320 2/6: Explain why a particular header is included

[Greg Chicares]

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

    Explain why a particular header is included
    
    Annotating the inclusion of "zero.hpp" with "// decimal_root()" makes
    it easy to find where a root is sought.
---
 calendar_date.cpp | 2 +-
 financial.hpp     | 2 +-
 gpt_specamt.cpp   | 2 +-
 ihs_avsolve.cpp   | 2 +-
 solve.cpp         | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/calendar_date.cpp b/calendar_date.cpp
index 0ae75afa..a472b047 100644
--- a/calendar_date.cpp
+++ b/calendar_date.cpp
@@ -26,7 +26,7 @@
 #include "alert.hpp"
 #include "assert_lmi.hpp"
 #include "bourn_cast.hpp"
-#include "zero.hpp"
+#include "zero.hpp"                     // decimal_root()
 
 #include <algorithm>                    // max(), min()
 #include <ctime>                        // time_t
diff --git a/financial.hpp b/financial.hpp
index 075ed601..1decaa1c 100644
--- a/financial.hpp
+++ b/financial.hpp
@@ -28,7 +28,7 @@
 #include "bourn_cast.hpp"
 #include "mc_enum_type_enums.hpp"       // mcenum_mode
 #include "miscellany.hpp"               // ios_out_app_binary()
-#include "zero.hpp"
+#include "zero.hpp"                     // decimal_root()
 
 #include <fstream>
 #include <iterator>                     // iterator_traits
diff --git a/gpt_specamt.cpp b/gpt_specamt.cpp
index 768fc232..8e254484 100644
--- a/gpt_specamt.cpp
+++ b/gpt_specamt.cpp
@@ -26,7 +26,7 @@
 #include "assert_lmi.hpp"
 #include "basic_values.hpp"
 #include "safely_dereference_as.hpp"
-#include "zero.hpp"
+#include "zero.hpp"                     // decimal_root()
 
 currency gpt_specamt::CalculateGLPSpecAmt
     (BasicValues const& a_Values
diff --git a/ihs_avsolve.cpp b/ihs_avsolve.cpp
index 4ead6273..e609c3dd 100644
--- a/ihs_avsolve.cpp
+++ b/ihs_avsolve.cpp
@@ -41,7 +41,7 @@
 #include "miscellany.hpp"               // ios_out_app_binary()
 #include "null_stream.hpp"
 #include "outlay.hpp"
-#include "zero.hpp"
+#include "zero.hpp"                     // decimal_root()
 
 #include <algorithm>                    // min(), max()
 #include <functional>
diff --git a/solve.cpp b/solve.cpp
index 3a30f303..989f1b97 100644
--- a/solve.cpp
+++ b/solve.cpp
@@ -31,7 +31,7 @@
 #include "mc_enum_types_aux.hpp"        // set_run_basis_from_cloven_bases()
 #include "outlay.hpp"
 #include "round_to.hpp"
-#include "zero.hpp"
+#include "zero.hpp"                     // decimal_root()
 
 #include <algorithm>                    // max(), min()