Browse Source

Update comment in response_classifier.h

As suggested in the review in ticket #487, an additional non-Doxygen
comment was added to the Category enum to indicate that for error()
to work, non-error codes should come before error codes.
Stephen Morris 14 years ago
parent
commit
98d6a12c51
1 changed files with 3 additions and 2 deletions
  1. 3 2
      src/bin/resolver/response_classifier.h

+ 3 - 2
src/bin/resolver/response_classifier.h

@@ -45,7 +45,7 @@ public:
     /// do not end with a non-CNAME RRset.
     enum Category {
 
-        // Packet is valid
+        // Codes indicating that a message is valid.
 
         ANSWER,             ///< Response contains the answer
         ANSWERCNAME,        ///< Response was a CNAME chain ending in an answer
@@ -53,7 +53,8 @@ public:
         NXDOMAIN,           ///< Response was an NXDOMAIN
         REFERRAL,           ///< Response contains a referral
 
-        // Packet is invalid
+        // Codes indicating that a message is invalid.  Note that the error()
+        // method relies on these appearing after the "message valid" codes.
 
         EMPTY,              ///< No answer or authority sections
         EXTRADATA,          ///< Answer section contains more RRsets than needed