Commit 8f149bd0 authored by Mukund Sivaraman's avatar Mukund Sivaraman
Browse files

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

parent 20167238
...@@ -64,6 +64,16 @@ protected: ...@@ -64,6 +64,16 @@ protected:
public: public:
virtual const isc::dns::AbstractRRset& getValue() = 0; virtual const isc::dns::AbstractRRset& getValue() = 0;
virtual IterPtr getNext() = 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; virtual bool equals(Iter& other) = 0;
}; };
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment