From: Mukund Sivaraman <muks@isc.org>
Date: Tue, 15 Jan 2013 05:39:14 +0000 (+0530)
Subject: [2435] Add documentation for RRsetCollectionPtr
X-Git-Tag: bind10-1.0.0-rc-release~109
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=75d921323cf83bf67ec24d28927ee472b517fa88;p=thirdparty%2Fkea.git

[2435] Add documentation for RRsetCollectionPtr
---

diff --git a/src/lib/dns/rrset_collection_base.h b/src/lib/dns/rrset_collection_base.h
index a368b40365..f757321649 100644
--- a/src/lib/dns/rrset_collection_base.h
+++ b/src/lib/dns/rrset_collection_base.h
@@ -171,6 +171,10 @@ public:
     }
 };
 
+/// \brief A pointer-like type pointing to an \c RRsetCollection object.
+///
+/// This type is used to handle RRsetCollections in a polymorphic manner
+/// in the BIND 10 codebase.
 typedef boost::shared_ptr<RRsetCollectionBase> RRsetCollectionPtr;
 
 } // end of namespace dns