diff options
| author | Paul Selkirk <pselkirk@isc.org> | 2013-04-26 02:38:13 +0200 |
|---|---|---|
| committer | Paul Selkirk <pselkirk@isc.org> | 2013-04-26 02:38:13 +0200 |
| commit | d06ff546486bc123c1fafbe8b20bb5e60557970c (patch) | |
| tree | a12be2d1a22f249695cb361c31da45ec5a225bdf /src/lib | |
| parent | [2521] constify (diff) | |
| download | kea-d06ff546486bc123c1fafbe8b20bb5e60557970c.tar.xz kea-d06ff546486bc123c1fafbe8b20bb5e60557970c.zip | |
[2521] doc cleanup for OPT, per Jinmei's review
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/dns/rdata/generic/opt_41.cc | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/lib/dns/rdata/generic/opt_41.cc b/src/lib/dns/rdata/generic/opt_41.cc index a44cb9b1b2..136bdf931a 100644 --- a/src/lib/dns/rdata/generic/opt_41.cc +++ b/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 (""); } |