From: Mukund Sivaraman <muks@isc.org>
Date: Tue, 29 Jan 2013 05:52:42 +0000 (+0530)
Subject: [2390] Add API doc for PTR constructors
X-Git-Tag: bind10-1.0.0-rc-release~65
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=859b69891fe1fc3be67bbd293397fbe7b989eb26;p=thirdparty%2Fkea.git

[2390] Add API doc for PTR constructors
---

diff --git a/src/lib/dns/rdata/generic/ptr_12.cc b/src/lib/dns/rdata/generic/ptr_12.cc
index 3aadb6e33d..15bd69f782 100644
--- a/src/lib/dns/rdata/generic/ptr_12.cc
+++ b/src/lib/dns/rdata/generic/ptr_12.cc
@@ -28,6 +28,20 @@ using namespace isc::util;
 // BEGIN_ISC_NAMESPACE
 // BEGIN_RDATA_NAMESPACE
 
+/// \brief Constructor from string.
+///
+/// The given string must represent a valid PTR 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 PTRDNAME 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.
 PTR::PTR(const std::string& type_str) :
     // Fill in dummy name and replace them soon below.
     ptr_name_(Name::ROOT_NAME())
@@ -56,6 +70,21 @@ PTR::PTR(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 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
+/// 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 PTRDNAME when it
+/// is non-absolute.
 PTR::PTR(MasterLexer& lexer, const Name* origin,
          MasterLoader::Options, MasterLoaderCallbacks&) :
     ptr_name_(createNameFromLexer(lexer, origin))