BIND 10 trac2387, updated. 72922ff97062fbb154821827932d8a8952c371fc [2387] Add API doc for NSEC3PARAM constructors

[BIND 10 source code commits]

The branch, trac2387 has been updated
       via  72922ff97062fbb154821827932d8a8952c371fc (commit)
      from  aa95c10d7631603afd110b43cc6f12da22fda7f0 (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 72922ff97062fbb154821827932d8a8952c371fc
Author: Mukund Sivaraman <muks at isc.org>
Date:   Tue Mar 12 08:30:59 2013 +0530

    [2387] Add API doc for NSEC3PARAM constructors

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

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

-----------------------------------------------------------------------
diff --git a/src/lib/dns/rdata/generic/nsec3param_51.cc b/src/lib/dns/rdata/generic/nsec3param_51.cc
index 0a41048..a38231a 100644
--- a/src/lib/dns/rdata/generic/nsec3param_51.cc
+++ b/src/lib/dns/rdata/generic/nsec3param_51.cc
@@ -46,6 +46,21 @@ struct NSEC3PARAMImpl {
     const vector<uint8_t> salt_;
 };
 
+/// \brief Constructor from string.
+///
+/// The given string must represent a valid NSEC3PARAM 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 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.
+///
+/// \throw InvalidRdataText if any fields are out of their valid range,
+/// or are incorrect.
+///
+/// \param nsec3param_str A string containing the RDATA to be created
 NSEC3PARAM::NSEC3PARAM(const std::string& nsec3param_str) :
     impl_(NULL)
 {
@@ -67,6 +82,22 @@ NSEC3PARAM::NSEC3PARAM(const std::string& nsec3param_str) :
     }
 }
 
+/// \brief Constructor with a context of MasterLexer.
+///
+/// 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.
+///
+/// \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
 NSEC3PARAM::NSEC3PARAM(MasterLexer& lexer, const Name*, MasterLoader::Options,
                        MasterLoaderCallbacks&) :
     impl_(NULL)