Parcourir la source

[2387] Unify constructor API documentation

Mukund Sivaraman il y a 12 ans
Parent
commit
945103ccf3

+ 2 - 4
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.

+ 2 - 8
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.

+ 2 - 3
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.