BIND 10 trac2387, updated. f909b685377ab7c3d16f5903ccc54d0465721046 [2387] Add API doc for parseNSEC3ParamFromLexer()

[BIND 10 source code commits]

The branch, trac2387 has been updated
       via  f909b685377ab7c3d16f5903ccc54d0465721046 (commit)
      from  9926f9b8f9f9ed697975752c62a46e34bf45e3ca (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 f909b685377ab7c3d16f5903ccc54d0465721046
Author: Mukund Sivaraman <muks at isc.org>
Date:   Mon Mar 11 12:28:27 2013 +0530

    [2387] Add API doc for parseNSEC3ParamFromLexer()

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

Summary of changes:
 .../dns/rdata/generic/detail/nsec3param_common.h   |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

-----------------------------------------------------------------------
diff --git a/src/lib/dns/rdata/generic/detail/nsec3param_common.h b/src/lib/dns/rdata/generic/detail/nsec3param_common.h
index 4d55ada..7d7ed54 100644
--- a/src/lib/dns/rdata/generic/detail/nsec3param_common.h
+++ b/src/lib/dns/rdata/generic/detail/nsec3param_common.h
@@ -92,6 +92,26 @@ ParseNSEC3ParamResult parseNSEC3ParamText(const char* const rrtype_name,
                                           std::istringstream& iss,
                                           std::vector<uint8_t>& salt);
 
+/// \brief Convert textual representation of NSEC3 parameters
+/// (MasterLexer variant).
+///
+/// This function is identical to \c parseNSEC3ParamText(), except that
+/// it reads the NSEC3 parameters from a MasterLexer.
+///
+/// \exception isc::BadValue The salt is not a valid hex string.
+/// \exception InvalidRdataText The given string is otherwise invalid for
+/// NSEC3 or NSEC3PARAM fields.
+/// \exception MasterLexer::LexerError There was a failure reading a
+/// field from the MasterLexer.
+///
+/// \param rrtype_name Either "NSEC3" or "NSEC3PARAM"; used as part of
+/// exception messages.
+/// \param lexer The MasterLexer to read NSEC3 parameter fields from.
+/// \param salt A placeholder for the salt field value of the RDATA.
+/// Expected to be empty, but it's not checked (and will be overridden).
+///
+/// \return The hash algorithm, flags, iterations in the form of
+/// ParseNSEC3ParamResult.
 ParseNSEC3ParamResult parseNSEC3ParamFromLexer(const char* const rrtype_name,
                                                isc::dns::MasterLexer& lexer,
                                                std::vector<uint8_t>& salt);