[lmi-commits] [lmi] master f2756051 2/4: Improve documentation

[Greg Chicares]

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

    Improve documentation
    
    Don't say
      "Implicitly-declared special member functions do the right thing."
    when they don't, or where there no longer are any.
---
 dbvalue.hpp            | 2 --
 fund_data.hpp          | 4 +---
 gpt_server.hpp         | 2 --
 ihs_irc7702a.hpp       | 2 --
 illustrator.hpp        | 2 --
 mec_server.hpp         | 2 --
 product_data.hpp       | 4 ----
 rounding_rules.hpp     | 5 ++---
 stratified_charges.hpp | 2 --
 test_coding_rules.cpp  | 2 --
 10 files changed, 3 insertions(+), 24 deletions(-)

diff --git a/dbvalue.hpp b/dbvalue.hpp
index 152a97ce..a0b0d5e0 100644
--- a/dbvalue.hpp
+++ b/dbvalue.hpp
@@ -50,8 +50,6 @@ namespace xml_serialize {template<typename T> struct xml_io;}
 /// all axes. In a typical query, all other axes are single-valued,
 /// but all durations are wanted; this axis ordering puts consecutive
 /// durational values in contiguous storage for efficient retrieval.
-///
-/// Implicitly-declared special member functions do the right thing.
 
 class LMI_SO database_entity final
 {
diff --git a/fund_data.hpp b/fund_data.hpp
index fc16d856..d7691a51 100644
--- a/fund_data.hpp
+++ b/fund_data.hpp
@@ -31,9 +31,7 @@
 #include <string>
 #include <vector>
 
-// Separate account funds: their names and investment mgmt fees
-
-// Implicitly-declared special member functions do the right thing.
+/// Separate account funds: names and investment management fees
 
 class LMI_SO FundInfo final
 {
diff --git a/gpt_server.hpp b/gpt_server.hpp
index 524be42e..57ae847b 100644
--- a/gpt_server.hpp
+++ b/gpt_server.hpp
@@ -40,8 +40,6 @@ class gpt_input;
 /// a distinct enumeration seems unwarranted, especially because
 /// explaining another one in '--help' would be too complicated.
 /// Enumerators that don't make sense can be reported at run time.
-///
-/// Implicitly-declared special member functions do the right thing.
 
 class LMI_SO gpt_server final
 {
diff --git a/ihs_irc7702a.hpp b/ihs_irc7702a.hpp
index 308d7354..b93fc521 100644
--- a/ihs_irc7702a.hpp
+++ b/ihs_irc7702a.hpp
@@ -38,8 +38,6 @@ LMI_SO void TestIrc7702A();
 //   7-pay premium strategy changes premium when spec amt changes;
 //   should optionally calculate factors e.g. 7pp, NSP from first principles.
 
-// Implicitly-declared special member functions do the right thing.
-
 class Irc7702A final
 {
   public:
diff --git a/illustrator.hpp b/illustrator.hpp
index 268ffbba..27832e49 100644
--- a/illustrator.hpp
+++ b/illustrator.hpp
@@ -35,8 +35,6 @@ class Input;
 class Ledger;
 
 /// Sole top-level facility for illustration generation.
-///
-/// Implicitly-declared special member functions do the right thing.
 
 class LMI_SO illustrator final
 {
diff --git a/mec_server.hpp b/mec_server.hpp
index d5828e6b..af9b8bef 100644
--- a/mec_server.hpp
+++ b/mec_server.hpp
@@ -40,8 +40,6 @@ class mec_input;
 /// a distinct enumeration seems unwarranted, especially because
 /// explaining another one in '--help' would be too complicated.
 /// Enumerators that don't make sense can be reported at run time.
-///
-/// Implicitly-declared special member functions do the right thing.
 
 class LMI_SO mec_server final
 {
diff --git a/product_data.hpp b/product_data.hpp
index 5b57d68a..e0e03a69 100644
--- a/product_data.hpp
+++ b/product_data.hpp
@@ -37,8 +37,6 @@
 /// For example, the principal string datum might be the full name of
 /// the issuing company, whereas the gloss might explain under what
 /// conditions that company is used instead of a sibling.
-///
-/// Implicitly-declared special member functions do the right thing.
 
 class glossed_string final
 {
@@ -80,8 +78,6 @@ template<> struct deserialized<product_data>
 ///
 /// This is the "master" product file: it includes the filenames of
 /// all other product files.
-///
-/// Implicitly-declared special member functions do the right thing.
 
 class LMI_SO product_data
     :public xml_serializable  <product_data>
diff --git a/rounding_rules.hpp b/rounding_rules.hpp
index e5ae95f1..9aa57e67 100644
--- a/rounding_rules.hpp
+++ b/rounding_rules.hpp
@@ -35,8 +35,6 @@
 #include <string>
 
 /// Parameters of a rounding rule.
-///
-/// Implicitly-declared special member functions do the right thing.
 
 class LMI_SO rounding_parameters final
 {
@@ -81,7 +79,8 @@ class LMI_SO rounding_parameters final
 /// rounding is a property of the transaction, and not of the variable
 /// it ultimately affects.
 ///
-/// Implicitly-declared special member functions do the right thing.
+/// Implicitly-declared special member functions do the right thing,
+/// except that there are none, only because they aren't needed.
 ///
 /// Notes on particular rounding functors.
 ///
diff --git a/stratified_charges.hpp b/stratified_charges.hpp
index a292e534..4c02d510 100644
--- a/stratified_charges.hpp
+++ b/stratified_charges.hpp
@@ -62,8 +62,6 @@ enum e_stratified
     };
 
 /// A tiered or banded datum.
-///
-/// Implicitly-declared special member functions do the right thing.
 
 class LMI_SO stratified_entity final
 {
diff --git a/test_coding_rules.cpp b/test_coding_rules.cpp
index c4dba41d..b8c3125d 100644
--- a/test_coding_rules.cpp
+++ b/test_coding_rules.cpp
@@ -1164,8 +1164,6 @@ void enforce_taboos(file const& f)
         }
 }
 
-/// Implicitly-declared special member functions do the right thing.
-
 class statistics
 {
   public: