From: Mukund Sivaraman <muks@isc.org>
Date: Thu, 10 Jan 2013 10:07:41 +0000 (+0530)
Subject: [2435] Add detailed doc for getRRsetCollection()
X-Git-Tag: bind10-1.0.0-rc-release~118
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a9a2f80671f01894e3c2909e8a185c8fb7396977;p=thirdparty%2Fkea.git

[2435] Add detailed doc for getRRsetCollection()
---

diff --git a/src/lib/datasrc/zone.h b/src/lib/datasrc/zone.h
index 3b61cd8d16..c7b50bcf21 100644
--- a/src/lib/datasrc/zone.h
+++ b/src/lib/datasrc/zone.h
@@ -804,6 +804,20 @@ public:
     virtual ZoneFinder& getFinder() = 0;
 
     /// Return an RRsetCollection for the updater.
+    ///
+    /// This method returns an \c RRsetCollection for the updater,
+    /// implementing the \c isc::dns::RRsetCollectionBase
+    /// interface. While the returned RRsetCollection object is
+    /// existing, the corresponding \c ZoneUpdater must not be
+    /// destroyed. The returned RRsetCollection object may be used to
+    /// search RRsets from the ZoneUpdater. The actual
+    /// \c RRsetCollection returned has a behavior dependent on the
+    /// \c ZoneUpdater implementation.
+    ///
+    /// The behavior of the RRsetCollection is similar to the behavior
+    /// of the \c Zonefinder returned by \c getFinder() with regards to
+    /// adding and deleting RRsets via \c addRRset() and \c
+    /// deleteRRset().
     virtual isc::dns::RRsetCollectionPtr getRRsetCollection() = 0;
 
     /// Add an RRset to a zone via the updater