Commit ab923703 authored by Michal Vaner's avatar Michal Vaner
Browse files

Doxygen documentation

git-svn-id: svn://bind10.isc.org/svn/bind10/branches/trac447@3961 e5f2f494-b856-4b98-b285-d166d9295462
parent 30c2e888
......@@ -57,24 +57,52 @@ public:
virtual const isc::dns::RRClass& getClass() const;
/// \brief Looks up an RRset in the zone.
///
///
/// See documentation in \c Zone.
///
/// It returns NULL pointer in case of NXDOMAIN and NXRRSET
/// (the base class documentation does not seem to require that).
///
/// It might throw AssertError as well, but it should not be
/// expected (and caught), as it marks programmer error.
virtual FindResult find(const isc::dns::Name& name,
const isc::dns::RRType& type) const;
/// \brief Inserts an rrset into the zone.
///
/// It puts another RRset into the zone.
///
/// It throws NullRRset or OutOfZone if the provided rrset is invalid.
/// It might throw AssertError, but that one marks programmer errors.
///
/// \param rrset The set to add.
/// \return SUCCESS or EXIST (if an rrset for given name and type already
/// exists).
result::Result add(const isc::dns::ConstRRsetPtr& rrset);
/// \brief RRSet out of zone exception.
///
/// This is thrown if addition of an RRset that doesn't belong under the
/// zone's origin is requested.
struct OutOfZone : public InvalidParameter {
OutOfZone(const char* file, size_t line, const char* what) :
InvalidParameter(file, line, what)
{ }
};
/// \brief RRset is NULL exception.
///
/// This is thrown if the provided RRset parameter is NULL.
struct NullRRset : public InvalidParameter {
NullRRset(const char* file, size_t line, const char* what) :
InvalidParameter(file, line, what)
{ }
};
/// \brief Internal programmer error.
///
/// This should not be expected. It means internal inconsistency is
/// detected, eg. it marks the "Can Not Happen" conditions.
struct AssertError : public Unexpected {
AssertError(const char* file, size_t line, const char* what) :
Unexpected(file, line, what)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment