From: Mukund Sivaraman <muks@isc.org>
Date: Tue, 1 Jan 2013 10:36:57 +0000 (+0530)
Subject: [2432] Add API doc for equals() about incompatible types
X-Git-Tag: bind10-1.0.0-rc-release~147
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8f149bd04986ba2542e86c7ce77e5d0e92df16ea;p=thirdparty%2Fkea.git

[2432] Add API doc for equals() about incompatible types
---

diff --git a/src/lib/dns/rrset_collection_base.h b/src/lib/dns/rrset_collection_base.h
index 2db50e7806..ead169dbae 100644
--- a/src/lib/dns/rrset_collection_base.h
+++ b/src/lib/dns/rrset_collection_base.h
@@ -64,6 +64,16 @@ protected:
     public:
         virtual const isc::dns::AbstractRRset& getValue() = 0;
         virtual IterPtr getNext() = 0;
+
+        /// \brief Check if another iterator is equal to this one.
+        ///
+        /// Returns \c true if this iterator is equal to \c other,
+        /// \c false otherwise. Note that if \c other is not the same
+        /// type as \c this, or cannot be compared meaningfully, the
+        /// method must return \c false.
+        ///
+        /// \param other The other iterator to compare against.
+        /// \returns \c true if equal, \c false otherwise.
         virtual bool equals(Iter& other) = 0;
     };