[2565] Add rationale for why bool is returned instead of throwing an exception

diff --git a/src/lib/dns/rrparamregistry.h b/src/lib/dns/rrparamregistry.h
index 08d06503ded13a730c43fe1c7e4d0eb7dcffdfe8..dfa4463055ebf518445e5be198dac2022aff4486 100644 (file)
--- a/src/lib/dns/rrparamregistry.h
+++ b/src/lib/dns/rrparamregistry.h
@@ -392,6 +392,10 @@ public:
     /// corresponding number as the type code in \c type_code;
     /// otherwise, it returns false and \c type_code is untouched.
     ///
+    /// We return \c false and avoid simply throwing an exception in the
+    /// case of an error so that the code is performant in some
+    /// situations.
+    ///
     /// \param type_string The textual representation of the RR type.
     /// \param type_code Returns the RR type code in this argument.
     /// \return true if conversion is successful, false otherwise.
@@ -427,6 +431,10 @@ public:
     /// \c class_code; otherwise, it returns false and \c class_code is
     /// untouched.
     ///
+    /// We return \c false and avoid simply throwing an exception in the
+    /// case of an error so that the code is performant in some
+    /// situations.
+    ///
     /// \param class_string The textual representation of the RR class.
     /// \param class_code Returns the RR class code in this argument.
     /// \return true if conversion is successful, false otherwise.