BIND 10 trac2390_2, updated. e6603386c50335787bca7443a9716414cf68c7bc [2390] Add API doc for MX constructors

[BIND 10 source code commits]

The branch, trac2390_2 has been updated
       via  e6603386c50335787bca7443a9716414cf68c7bc (commit)
       via  5d1563f963952af222030a404b21a0bc8171e2ac (commit)
      from  859b69891fe1fc3be67bbd293397fbe7b989eb26 (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 e6603386c50335787bca7443a9716414cf68c7bc
Author: Mukund Sivaraman <muks at isc.org>
Date:   Tue Jan 29 11:28:13 2013 +0530

    [2390] Add API doc for MX constructors

commit 5d1563f963952af222030a404b21a0bc8171e2ac
Author: Mukund Sivaraman <muks at isc.org>
Date:   Tue Jan 29 11:28:07 2013 +0530

    [2390] Make minor documentation updates

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

Summary of changes:
 src/lib/dns/rdata/generic/mx_15.cc  |   34 ++++++++++++++++++++++++++++++++++
 src/lib/dns/rdata/generic/ns_2.cc   |    7 ++++---
 src/lib/dns/rdata/generic/ptr_12.cc |    7 ++++---
 3 files changed, 42 insertions(+), 6 deletions(-)

-----------------------------------------------------------------------
diff --git a/src/lib/dns/rdata/generic/mx_15.cc b/src/lib/dns/rdata/generic/mx_15.cc
index 70fa294..c2001ca 100644
--- a/src/lib/dns/rdata/generic/mx_15.cc
+++ b/src/lib/dns/rdata/generic/mx_15.cc
@@ -42,6 +42,22 @@ MX::MX(InputBuffer& buffer, size_t) :
     // check consistency.
 }
 
+/// \brief Constructor from string.
+///
+/// The given string must represent a valid MX 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 EXCHANGE name must be absolute since there's no parameter that
+/// specifies the origin name; if it is not absolute, \c MissingNameOrigin
+/// exception will be thrown. It must not be represented as a quoted
+/// string.
+///
+/// See the construction that takes \c MasterLexer for other fields.
+///
+/// \throw Others Exception from the Name and RRTTL constructors.
+/// \throw InvalidRdataText Other general syntax errors.
 MX::MX(const std::string& mx_str) :
     // Fill in dummy name and replace them soon below.
     preference_(0), mxname_(Name::ROOT_NAME())
@@ -70,6 +86,24 @@ MX::MX(const std::string& mx_str) :
     }
 }
 
+/// \brief Constructor with a context of MasterLexer.
+///
+/// The \c lexer should point to the beginning of valid textual representation
+/// of an MX RDATA.  The EXCHANGE 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.
+///
+/// The PREFERENCE field must be a valid decimal representation of an
+/// unsigned 16-bit integer.
+///
+/// \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 EXCHANGE when it
+/// is non-absolute.
 MX::MX(MasterLexer& lexer, const Name* origin,
        MasterLoader::Options, MasterLoaderCallbacks&) :
     preference_(0), mxname_(".")
diff --git a/src/lib/dns/rdata/generic/ns_2.cc b/src/lib/dns/rdata/generic/ns_2.cc
index 6a91bff..2f0278f 100644
--- a/src/lib/dns/rdata/generic/ns_2.cc
+++ b/src/lib/dns/rdata/generic/ns_2.cc
@@ -75,9 +75,10 @@ NS::NS(InputBuffer& buffer, size_t) :
 /// \brief Constructor with a context of MasterLexer.
 ///
 /// The \c lexer should point to the beginning of valid textual
-/// representation of an NS RDATA.  The NSDNAME 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.
+/// representation of an NS RDATA.  The NSDNAME 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
diff --git a/src/lib/dns/rdata/generic/ptr_12.cc b/src/lib/dns/rdata/generic/ptr_12.cc
index 15bd69f..beec038 100644
--- a/src/lib/dns/rdata/generic/ptr_12.cc
+++ b/src/lib/dns/rdata/generic/ptr_12.cc
@@ -73,9 +73,10 @@ PTR::PTR(InputBuffer& buffer, size_t) :
 /// \brief Constructor with a context of MasterLexer.
 ///
 /// The \c lexer should point to the beginning of valid textual
-/// representation of a PTR RDATA.  The PTRDNAME 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.
+/// representation of a PTR RDATA.  The PTRDNAME 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