From: Mukund Sivaraman <muks@isc.org>
Date: Mon, 25 Mar 2013 07:50:06 +0000 (+0530)
Subject: [2387] Unify constructor API documentation
X-Git-Tag: bind10-1.2.0beta1-release~481^2~38
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=945103ccf34fe1140877c1dda05a98eb4ee79d98;p=thirdparty%2Fkea.git

[2387] Unify constructor API documentation
---

diff --git a/src/lib/dns/rdata/generic/dnskey_48.cc b/src/lib/dns/rdata/generic/dnskey_48.cc
index 2cba1be2ed..228f984827 100644
--- a/src/lib/dns/rdata/generic/dnskey_48.cc
+++ b/src/lib/dns/rdata/generic/dnskey_48.cc
@@ -121,10 +121,8 @@ DNSKEY::DNSKEY(InputBuffer& buffer, size_t rdata_len) {
 /// The \c lexer should point to the beginning of valid textual
 /// representation of an DNSKEY RDATA.
 ///
-/// The Protocol and Algorithm fields must be within their valid
-/// ranges. The Public Key field must be present and must contain a
-/// Base64 encoding of the public key. Whitespace is allowed within the
-/// Base64 text.
+/// See \c DNSKEY::DNSKEY(const std::string&) for description of the
+/// expected RDATA fields.
 ///
 /// \throw MasterLexer::LexerError General parsing error such as
 /// missing field.
diff --git a/src/lib/dns/rdata/generic/nsec3_50.cc b/src/lib/dns/rdata/generic/nsec3_50.cc
index c66f09d47d..6c65cd2802 100644
--- a/src/lib/dns/rdata/generic/nsec3_50.cc
+++ b/src/lib/dns/rdata/generic/nsec3_50.cc
@@ -74,7 +74,6 @@ struct NSEC3Impl {
 /// The Hash Algorithm, Flags and Iterations fields must be within their
 /// valid ranges. The Salt field may contain "-" to indicate that the
 /// salt is of length 0. The Salt field must not contain any whitespace.
-///
 /// The type mnemonics must be valid, and separated by whitespace. If
 /// any invalid mnemonics are found, InvalidRdataText exception is
 /// thrown.
@@ -109,13 +108,8 @@ NSEC3::NSEC3(const std::string& nsec3_str) :
 /// The \c lexer should point to the beginning of valid textual
 /// representation of an NSEC3 RDATA.
 ///
-/// The Hash Algorithm, Flags and Iterations fields must be within their
-/// valid ranges. The Salt field may contain "-" to indicate that the
-/// salt is of length 0. The Salt field must not contain any whitespace.
-///
-/// The type mnemonics must be valid, and separated by whitespace. If
-/// any invalid mnemonics are found, InvalidRdataText exception is
-/// thrown.
+/// See \c NSEC3::NSEC3(const std::string&) for description of the
+/// expected RDATA fields.
 ///
 /// \throw MasterLexer::LexerError General parsing error such as
 /// missing field.
diff --git a/src/lib/dns/rdata/generic/nsec3param_51.cc b/src/lib/dns/rdata/generic/nsec3param_51.cc
index a38231a55c..a4cfe097de 100644
--- a/src/lib/dns/rdata/generic/nsec3param_51.cc
+++ b/src/lib/dns/rdata/generic/nsec3param_51.cc
@@ -87,9 +87,8 @@ NSEC3PARAM::NSEC3PARAM(const std::string& nsec3param_str) :
 /// The \c lexer should point to the beginning of valid textual
 /// representation of an NSEC3PARAM RDATA.
 ///
-/// The Hash Algorithm, Flags and Iterations fields must be within their
-/// valid ranges. The Salt field may contain "-" to indicate that the
-/// salt is of length 0. The Salt field must not contain any whitespace.
+/// See \c NSEC3PARAM::NSEC3PARAM(const std::string&) for description of
+/// the expected RDATA fields.
 ///
 /// \throw MasterLexer::LexerError General parsing error such as
 /// missing field.