jkesselm 00/12/15 13:24:39
Modified: java/src/org/apache/xpath DOMHelper.java
Log:
Docs
Revision Changes Path
1.20 +15 -11 xml-xalan/java/src/org/apache/xpath/DOMHelper.java
Index: DOMHelper.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/DOMHelper.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- DOMHelper.java 2000/12/15 21:17:28 1.19
+++ DOMHelper.java 2000/12/15 21:24:37 1.20
@@ -868,9 +868,13 @@
* return that information.
* @deprecated
*
- * NEEDSDOC @param node
+ * @param node Node to be examined
*
- * NEEDSDOC ($objectName$) @return
+ * @return CURRENTLY HARDCODED TO FALSE, but should return true if
+ * and only if the node is of type Text, contains only whitespace,
+ * and does not appear as part of the #PCDATA content of an element.
+ * (Note that determining this last may require allowing for
+ * Entity References.)
*/
public boolean isIgnorableWhitespace(Text node)
{
@@ -1228,15 +1232,15 @@
}
/**
- * Get the textual contents of the node. If the node
- * is an element, apply whitespace stripping rules,
- * though I'm not sure if this is right (I'll fix
- * or declare victory when I review the entire
- * whitespace handling).
- *
- * NEEDSDOC @param node
- *
- * NEEDSDOC ($objectName$) @return
+ * Get the textual contents of the node. See
+ * getNodeData(Node,FastStringBuffer) for discussion of how
+ * whitespace nodes are handled.
+ *
+ * @param node DOM Node to be examined
+ * @return String containing a concatenation of all the
+ * textual content within that node.
+ * @see getNodeData(Node,FastStringBuffer)
+ *
*/
public static String getNodeData(Node node)
{
