You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by ab...@locus.apache.org on 2000/02/10 21:38:47 UTC
cvs commit: xml-xerces/c/src/dom DOM_NodeList.hpp
abagchi 00/02/10 12:38:47
Modified: c/src/dom DOM_NodeList.hpp
Log:
Added docs for equality operators
Revision Changes Path
1.6 +30 -4 xml-xerces/c/src/dom/DOM_NodeList.hpp
Index: DOM_NodeList.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/dom/DOM_NodeList.hpp,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DOM_NodeList.hpp 2000/02/06 07:47:30 1.5
+++ DOM_NodeList.hpp 2000/02/10 20:38:46 1.6
@@ -56,6 +56,9 @@
/**
* $Log: DOM_NodeList.hpp,v $
+ * Revision 1.6 2000/02/10 20:38:46 abagchi
+ * Added docs for equality operators
+ *
* Revision 1.5 2000/02/06 07:47:30 rahulj
* Year 2K copyright swat.
*
@@ -161,21 +164,44 @@
//@{
/**
- * Equality operator. Note that compares whether two node list
+ * Equality operator.
+ * Compares whether two node list
* variables refer to the same underlying node list. It does
* not compare the contents of the node lists themselves.
+ *
+ * @param other The value to be compared
+ * @return Returns true if node list refers to same underlying node list
*/
bool operator == (const DOM_NodeList &other) const;
+ /**
+ * Use this comparison operator to test whether a Node List reference
+ * is null.
+ *
+ * @param nullPtr The value to be compared, which must be 0 or null.
+ * @return Returns true if node list reference is null
+ */
+ bool operator == (const DOM_NullPtr *nullPtr) const;
+
/**
- * Equality operator. Note that compares whether two node list
+ * Inequality operator.
+ * Compares whether two node list
* variables refer to the same underlying node list. It does
* not compare the contents of the node lists themselves.
+ *
+ * @param other The value to be compared
+ * @return Returns true if node list refers to a different underlying node list
*/
bool operator != (const DOM_NodeList &other) const;
- bool operator == (const DOM_NullPtr *nullPtr) const;
- bool operator != (const DOM_NullPtr *nullPtr) const;
+ /**
+ * Use this comparison operator to test whether a Node List reference
+ * is not null.
+ *
+ * @param nullPtr The value to be compared, which must be 0 or null.
+ * @return Returns true if node list reference is not null
+ */
+ bool operator != (const DOM_NullPtr *nullPtr) const;
//@}