[svn] commit: r3924 - /branches/trac441/src/lib/datasrc/memory_datasrc.h

[BIND 10 source code commits]

Author: vorner
Date: Tue Dec 21 09:32:05 2010
New Revision: 3924

Log:
Doxygen documentation

Modified:
    branches/trac441/src/lib/datasrc/memory_datasrc.h

Modified: branches/trac441/src/lib/datasrc/memory_datasrc.h
==============================================================================
--- branches/trac441/src/lib/datasrc/memory_datasrc.h (original)
+++ branches/trac441/src/lib/datasrc/memory_datasrc.h Tue Dec 21 09:32:05 2010
@@ -64,24 +64,54 @@
     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).
+    /// \todo This returns SOA, not NS in case of delegation. Which is
+    /// correct?
+    ///
+    /// 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)