]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[2387] Unify constructor API documentation
authorMukund Sivaraman <muks@isc.org>
Mon, 25 Mar 2013 07:50:06 +0000 (13:20 +0530)
committerMukund Sivaraman <muks@isc.org>
Mon, 25 Mar 2013 07:50:06 +0000 (13:20 +0530)
src/lib/dns/rdata/generic/dnskey_48.cc
src/lib/dns/rdata/generic/nsec3_50.cc
src/lib/dns/rdata/generic/nsec3param_51.cc

index 2cba1be2edc93c1ff7241af34856f1e4ed32cfc3..228f984827f047eb0f871e7146393a4a5d61bdd6 100644 (file)
@@ -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.
index c66f09d47df0018acae58db64186bc6150be193b..6c65cd2802ff0b7041868a12450ff943bb0b9bce 100644 (file)
@@ -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.
index a38231a55c1956c8647597fff14e57b33e997b0c..a4cfe097deadd373717a7a0f463a1d1ba3d52458 100644 (file)
@@ -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.