[2435] Describe that a reference to the updater is kept

diff --git a/src/lib/datasrc/rrset_collection.h b/src/lib/datasrc/rrset_collection.h
index df307c726f13a65bc323f1aedddb622439f3e0cd..4effd4fb48fbb02d2c9f8b7e4b6866208284fb9c 100644 (file)
--- a/src/lib/datasrc/rrset_collection.h
+++ b/src/lib/datasrc/rrset_collection.h
@@ -26,6 +26,12 @@ namespace datasrc {
 class RRsetCollection : public isc::dns::RRsetCollectionBase {
 public:
     /// \brief Constructor.
+    ///
+    /// A reference to the \c updater (via \c shared_ptr) is taken when
+    /// the collection is constructed. As long as the collection object
+    /// is alive, the reference to the updater is kept and it cannot be
+    /// destroyed by the client.
+    ///
     /// \param updater The ZoneUpdater to wrap around.
     RRsetCollection(ZoneUpdaterPtr updater) :
         updater_(updater)