BIND 10 trac2656_2, updated. 7e110b499a751ca43a473a94eb4448bdbe78a32a [2656] Add API doc for DNAME constructors

[BIND 10 source code commits]

The branch, trac2656_2 has been updated
       via  7e110b499a751ca43a473a94eb4448bdbe78a32a (commit)
       via  2db190194445d191e1d1eb75f0fc1936d0a791df (commit)
      from  17a9c25450a3129fa5787a5deb70d371a602f311 (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 7e110b499a751ca43a473a94eb4448bdbe78a32a
Author: Mukund Sivaraman <muks at isc.org>
Date:   Tue Jan 29 13:20:41 2013 +0530

    [2656] Add API doc for DNAME constructors

commit 2db190194445d191e1d1eb75f0fc1936d0a791df
Author: Mukund Sivaraman <muks at isc.org>
Date:   Tue Jan 29 13:17:58 2013 +0530

    [2656] Add API doc for CNAME constructors

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

Summary of changes:
 src/lib/dns/rdata/generic/cname_5.cc  |   30 ++++++++++++++++++++++++++++++
 src/lib/dns/rdata/generic/dname_39.cc |   30 ++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)

-----------------------------------------------------------------------
diff --git a/src/lib/dns/rdata/generic/cname_5.cc b/src/lib/dns/rdata/generic/cname_5.cc
index 66c9ceb..e87eeec 100644
--- a/src/lib/dns/rdata/generic/cname_5.cc
+++ b/src/lib/dns/rdata/generic/cname_5.cc
@@ -31,6 +31,20 @@ using isc::dns::rdata::generic::detail::createNameFromLexer;
 // BEGIN_ISC_NAMESPACE
 // BEGIN_RDATA_NAMESPACE
 
+/// \brief Constructor from string.
+///
+/// The given string must represent a valid CNAME 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 CNAME must be absolute since there's no parameter that specifies
+/// the origin name; if it is not absolute, \c MissingNameOrigin
+/// exception will be thrown.  These must not be represented as a quoted
+/// string.
+///
+/// \throw Others Exception from the Name and RRTTL constructors.
+/// \throw InvalidRdataText Other general syntax errors.
 CNAME::CNAME(const std::string& namestr) :
     // Fill in dummy name and replace it soon below.
     cname_(Name::ROOT_NAME())
@@ -59,6 +73,22 @@ CNAME::CNAME(InputBuffer& buffer, size_t) :
     // check consistency.
 }
 
+/// \brief Constructor with a context of MasterLexer.
+///
+/// The \c lexer should point to the beginning of valid textual
+/// representation of a CNAME RDATA.  The CNAME field can be
+/// non-absolute if \c origin is non-NULL, in which case \c origin is
+/// used to make it absolute.  It must not be represented as a quoted
+/// string.
+///
+/// \throw MasterLexer::LexerError General parsing error such as missing field.
+/// \throw Other Exceptions from the Name and RRTTL constructors if
+/// construction of textual fields as these objects fail.
+///
+/// \param lexer A \c MasterLexer object parsing a master file for the
+/// RDATA to be created
+/// \param origin If non NULL, specifies the origin of CNAME when it
+/// is non-absolute.
 CNAME::CNAME(MasterLexer& lexer, const Name* origin,
              MasterLoader::Options, MasterLoaderCallbacks&) :
     cname_(createNameFromLexer(lexer, origin))
diff --git a/src/lib/dns/rdata/generic/dname_39.cc b/src/lib/dns/rdata/generic/dname_39.cc
index 5bd81f5..d1d349e 100644
--- a/src/lib/dns/rdata/generic/dname_39.cc
+++ b/src/lib/dns/rdata/generic/dname_39.cc
@@ -31,6 +31,20 @@ using isc::dns::rdata::generic::detail::createNameFromLexer;
 // BEGIN_ISC_NAMESPACE
 // BEGIN_RDATA_NAMESPACE
 
+/// \brief Constructor from string.
+///
+/// The given string must represent a valid DNAME 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 TARGET must be absolute since there's no parameter that specifies
+/// the origin name; if it is not absolute, \c MissingNameOrigin
+/// exception will be thrown.  These must not be represented as a quoted
+/// string.
+///
+/// \throw Others Exception from the Name and RRTTL constructors.
+/// \throw InvalidRdataText Other general syntax errors.
 DNAME::DNAME(const std::string& namestr) :
     // Fill in dummy name and replace it soon below.
     dname_(Name::ROOT_NAME())
@@ -59,6 +73,22 @@ DNAME::DNAME(InputBuffer& buffer, size_t) :
     // check consistency.
 }
 
+/// \brief Constructor with a context of MasterLexer.
+///
+/// The \c lexer should point to the beginning of valid textual
+/// representation of a DNAME RDATA.  The TARGET field can be
+/// non-absolute if \c origin is non-NULL, in which case \c origin is
+/// used to make it absolute.  It must not be represented as a quoted
+/// string.
+///
+/// \throw MasterLexer::LexerError General parsing error such as missing field.
+/// \throw Other Exceptions from the Name and RRTTL constructors if
+/// construction of textual fields as these objects fail.
+///
+/// \param lexer A \c MasterLexer object parsing a master file for the
+/// RDATA to be created
+/// \param origin If non NULL, specifies the origin of TARGET when it
+/// is non-absolute.
 DNAME::DNAME(MasterLexer& lexer, const Name* origin,
              MasterLoader::Options, MasterLoaderCallbacks&) :
     dname_(createNameFromLexer(lexer, origin))