BIND 10 trac2387, updated. 863be53af8c369067f33c4b5688b44ebb380f789 [2387] Add API doc for DNSKEY constructors

[BIND 10 source code commits]

The branch, trac2387 has been updated
       via  863be53af8c369067f33c4b5688b44ebb380f789 (commit)
      from  86f31f3156e151a9446396aa04105c8dbfb6b592 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 863be53af8c369067f33c4b5688b44ebb380f789
Author: Mukund Sivaraman <muks at isc.org>
Date:   Mon Mar 11 13:19:19 2013 +0530

    [2387] Add API doc for DNSKEY constructors

-----------------------------------------------------------------------

Summary of changes:
 src/lib/dns/rdata/generic/dnskey_48.cc |   33 ++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

-----------------------------------------------------------------------
diff --git a/src/lib/dns/rdata/generic/dnskey_48.cc b/src/lib/dns/rdata/generic/dnskey_48.cc
index ada8880..da32144 100644
--- a/src/lib/dns/rdata/generic/dnskey_48.cc
+++ b/src/lib/dns/rdata/generic/dnskey_48.cc
@@ -51,6 +51,22 @@ struct DNSKEYImpl {
     const vector<uint8_t> keydata_;
 };
 
+/// \brief Constructor from string.
+///
+/// The given string must represent a valid DNSKEY RDATA.  There can be
+/// extra space characters at the beginning or end of the text (which
+/// are simply ignored), but other extra text, including a new line,
+/// will make the construction fail with an exception.
+///
+/// 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.
+///
+/// \throw InvalidRdataText if any fields are out of their valid range,
+/// or are incorrect.
+///
+/// \param dnskey_str A string containing the RDATA to be created
 DNSKEY::DNSKEY(const std::string& dnskey_str) :
     impl_(NULL)
 {
@@ -88,6 +104,23 @@ DNSKEY::DNSKEY(InputBuffer& buffer, size_t rdata_len) {
     impl_ = new DNSKEYImpl(flags, protocol, algorithm, keydata);
 }
 
+/// \brief Constructor with a context of MasterLexer.
+///
+/// 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.
+///
+/// \throw MasterLexer::LexerError General parsing error such as
+/// missing field.
+/// \throw InvalidRdataText if any fields are out of their valid range,
+/// or are incorrect.
+///
+/// \param lexer A \c MasterLexer object parsing a master file for the
+/// RDATA to be created
 DNSKEY::DNSKEY(MasterLexer& lexer, const Name*,
                MasterLoader::Options, MasterLoaderCallbacks&) :
     impl_(NULL)