BIND 10 trac2432, updated. 8f149bd04986ba2542e86c7ce77e5d0e92df16ea [2432] Add API doc for equals() about incompatible types

[BIND 10 source code commits]

The branch, trac2432 has been updated
       via  8f149bd04986ba2542e86c7ce77e5d0e92df16ea (commit)
      from  201672389bfa78c8eb59e122f6f117d1eb0644ed (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 8f149bd04986ba2542e86c7ce77e5d0e92df16ea
Author: Mukund Sivaraman <muks at isc.org>
Date:   Tue Jan 1 16:06:57 2013 +0530

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

-----------------------------------------------------------------------

Summary of changes:
 src/lib/dns/rrset_collection_base.h |   10 ++++++++++
 1 file changed, 10 insertions(+)

-----------------------------------------------------------------------
diff --git a/src/lib/dns/rrset_collection_base.h b/src/lib/dns/rrset_collection_base.h
index 2db50e7..ead169d 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;
     };