Browse Source

[2432] Document the state of the collection for empty constructor

Mukund Sivaraman 12 years ago
parent
commit
8bca74f57a
1 changed files with 4 additions and 0 deletions
  1. 4 0
      src/lib/dns/rrset_collection.h

+ 4 - 0
src/lib/dns/rrset_collection.h

@@ -31,6 +31,10 @@ namespace dns {
 class RRsetCollection : public RRsetCollectionBase {
 public:
     /// \brief Constructor.
+    ///
+    /// This constructor creates an empty collection without any data in
+    /// it. RRsets can be added to the collection with the \c addRRset()
+    /// method.
     RRsetCollection() {}
 
     /// \brief Constructor.