Browse Source

[2521] doc cleanup for OPT, per Jinmei's review

Paul Selkirk 12 years ago
parent
commit
d06ff54648
1 changed files with 5 additions and 1 deletions
  1. 5 1
      src/lib/dns/rdata/generic/opt_41.cc

+ 5 - 1
src/lib/dns/rdata/generic/opt_41.cc

@@ -20,7 +20,6 @@
 #include <dns/messagerenderer.h>
 #include <dns/rdata.h>
 #include <dns/rdataclass.h>
-#include <dns/rdata/generic/detail/lexer_util.h>
 
 using namespace std;
 using namespace isc::util;
@@ -30,6 +29,8 @@ using namespace isc::util;
 
 /// \brief Constructor from string.
 ///
+/// This constructor cannot be used, and always throws an exception.
+///
 /// \throw InvalidRdataText OPT RR cannot be constructed from text.
 OPT::OPT(const std::string&) {
     isc_throw(InvalidRdataText, "OPT RR cannot be constructed from text");
@@ -37,6 +38,8 @@ OPT::OPT(const std::string&) {
 
 /// \brief Constructor with a context of MasterLexer.
 ///
+/// This constructor cannot be used, and always throws an exception.
+///
 /// \throw InvalidRdataText OPT RR cannot be constructed from text.
 OPT::OPT(MasterLexer&, const Name*,
        MasterLoader::Options, MasterLoaderCallbacks&)
@@ -61,6 +64,7 @@ OPT::OPT(const OPT&) : Rdata() {
 
 std::string
 OPT::toText() const {
+    // OPT records do not have a text format.
     return ("");
 }