jkesselm 00/12/15 18:54:21
Modified: java/src/org/apache/xpath DOMOrder.java
Log:
Doc
Revision Changes Path
1.3 +6 -2 xml-xalan/java/src/org/apache/xpath/DOMOrder.java
Index: DOMOrder.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/DOMOrder.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DOMOrder.java 2000/10/30 18:58:21 1.2
+++ DOMOrder.java 2000/12/16 02:54:21 1.3
@@ -58,7 +58,8 @@
/**
* Nodes that implement this index can return a document order index.
- * Eventually, this will be replaced by DOM 3 methods.
+ * Eventually, this will be replaced by DOM 3 methods.
+ * (compareDocumentOrder and/or compareTreePosition.)
*/
public interface DOMOrder
{
@@ -66,7 +67,10 @@
/**
* Get the UID (document order index).
*
- * NEEDSDOC ($objectName$) @return
+ * @return integer whose relative value corresponds to document order
+ * -- that is, if node1.getUid()<node2.getUid(), node1 comes before
+ * node2, and if they're equal node1 and node2 are the same node. No
+ * promises are made beyond that.
*/
public int getUid();
}
