mmidy 00/11/08 12:45:38
Modified: java/src/org/apache/xalan/stree Parent.java
ProcessingInstructionImpl.java
SourceTreeHandler.java StreeDOMBuilder.java
StreeDOMHelper.java TextImpl.java WhiteSpace.java
Log:
More Documentation changes!!!
Revision Changes Path
1.13 +20 -18 xml-xalan/java/src/org/apache/xalan/stree/Parent.java
Index: Parent.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/stree/Parent.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Parent.java 2000/11/03 23:28:07 1.12
+++ Parent.java 2000/11/08 20:45:09 1.13
@@ -68,7 +68,8 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class Parent <needs-comment/>
+ * Class representing a parent node. A parent is also a child unless
+ * it is the root node.
*/
public class Parent extends Child
{
@@ -77,26 +78,26 @@
* Constructor Parent
*
*
- * NEEDSDOC @param doc
+ * @param doc Document object
*/
public Parent(DocumentImpl doc)
{
super(doc);
}
- /** NEEDSDOC Field m_posInChildList */
+ /** The position of this node in its parent's children list */
protected int m_posInChildList;
- /** NEEDSDOC Field m_childCount */
+ /** Number of children of this node. This number also includes attribute
nodes */
protected int m_childCount = 0; // includes attributes, elements
- /** NEEDSDOC Field m_isComplete */
+ /** Flag indicating whether all children of this node have been processed
*/
boolean m_isComplete = false;
- /** NEEDSDOC Field m_last */
+ /** This node's last child */
Child m_last;
- /** NEEDSDOC Field m_first */
+ /** This node's first child */
Child m_first;
/**
@@ -106,7 +107,7 @@
* it is likely that more children will be added.
* DON'T CALL THIS FUNCTION IF YOU CAN HELP IT!!!
*
- * NEEDSDOC ($objectName$) @return
+ * @return number of children this node currently contains
*/
public int getChildCount()
{
@@ -184,9 +185,10 @@
* Get the position of the child of an element in the document.
* Note that this is assuming an index starting at 1
*
- * NEEDSDOC @param pos
+ * @param pos Position of the child in this parent's children list
*
- * NEEDSDOC ($objectName$) @return
+ * @return the position of this child in the document or -1 if the child
+ * is not found
*/
public int getChildUID(int pos)
{
@@ -200,7 +202,7 @@
* Get the nth child.
* @param i the index of the child.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The child node at the specified position or null if none found
* @exception ArrayIndexOutOfBoundsException if the index is out of bounds.
* @exception NullPointerException if there are no children.
*/
@@ -259,7 +261,7 @@
* The first child of this node. If there is no such node, this returns
* <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The first child of this parent or null if none found
*/
public Node getFirstChild()
{
@@ -297,7 +299,7 @@
* The last child of this node. If there is no such node, this returns
* <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The last child of this parent
*/
public Node getLastChild()
{
@@ -316,7 +318,7 @@
* Append a child to the child list.
* @param newChild Must be a org.apache.xalan.stree.Child.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The node we just added to this parent's children list
* @exception ClassCastException if the newChild isn't a
org.apache.xalan.stree.Child.
*
* @throws DOMException
@@ -394,7 +396,7 @@
* Return if this node has had all it's children added, i.e.
* if a endElement event has occured.
*
- * NEEDSDOC ($objectName$) @return
+ * @return whether this node has had all it's children added or not
*/
public boolean isComplete()
{
@@ -409,7 +411,7 @@
* Set that this node's child list is complete, i.e.
* an endElement event has occured.
*
- * NEEDSDOC @param isComplete
+ * @param isComplete flag indicating whether this node has had all it's
children added
*/
public void setComplete(boolean isComplete)
{
@@ -417,10 +419,10 @@
}
/**
- * NEEDSDOC Method throwParseError
+ * Throw a ParseError exception
*
*
- * NEEDSDOC @param e
+ * @param e The original exception
*/
protected void throwParseError(Exception e)
{
1.5 +15 -14
xml-xalan/java/src/org/apache/xalan/stree/ProcessingInstructionImpl.java
Index: ProcessingInstructionImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/ProcessingInstructionImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ProcessingInstructionImpl.java 2000/10/30 18:43:53 1.4
+++ ProcessingInstructionImpl.java 2000/11/08 20:45:10 1.5
@@ -61,24 +61,24 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class ProcessingInstructionImpl <needs-comment/>
+ * Class to hold information about ProcessingInstruction node
*/
public class ProcessingInstructionImpl extends Child
implements ProcessingInstruction
{
- /** NEEDSDOC Field m_name */
+ /** PI's target (see getTarget for more info */
private String m_name;
- /** NEEDSDOC Field m_data */
+ /** PI's content */
private String m_data;
/**
* Implement the processingInstruction event.
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param target
- * NEEDSDOC @param data
+ * @param doc Document object
+ * @param target PI's target
+ * @param data PI's content
*/
ProcessingInstructionImpl(DocumentImpl doc, String target, String data)
{
@@ -96,7 +96,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return This PI's target
*/
public String getLocalName()
{
@@ -104,9 +104,10 @@
}
/**
- * Get the PI name.
+ * Get the PI name.
+ * Note that getNodeName is aliased to getTarget.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This PI's target
*/
public String getNodeName()
{
@@ -117,7 +118,7 @@
* A short integer indicating what type of node this is. The named
* constants for this value are defined in the org.w3c.dom.Node interface.
*
- * NEEDSDOC ($objectName$) @return
+ * @return PROCESSING_INSTRUCTION_NODE node type
*/
public short getNodeType()
{
@@ -135,7 +136,7 @@
* <p>
* Note that getNodeName is aliased to getTarget.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This PI's target
*/
public String getTarget()
{
@@ -147,7 +148,7 @@
* white space character after the target to the character immediately
* preceding the <code>?></code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This PI's data
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
*/
@@ -157,10 +158,10 @@
}
/**
- * NEEDSDOC Method getNodeValue
+ * Same as getData
*
*
- * NEEDSDOC (getNodeValue) @return
+ * @return This PI's data
*/
public String getNodeValue()
{
1.17 +67 -52
xml-xalan/java/src/org/apache/xalan/stree/SourceTreeHandler.java
Index: SourceTreeHandler.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/SourceTreeHandler.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- SourceTreeHandler.java 2000/11/06 17:46:19 1.16
+++ SourceTreeHandler.java 2000/11/08 20:45:11 1.17
@@ -102,7 +102,8 @@
* Create a SourceTreeHandler that will start a transformation as
* soon as a startDocument occurs.
*
- * NEEDSDOC @param transformer
+ * @param transformer The transformer this will use to transform a
+ * source tree into a result tree.
*/
public SourceTreeHandler(TransformerImpl transformer)
{
@@ -136,25 +137,28 @@
m_initedRoot = false;
}
- /** NEEDSDOC Field m_transformer */
+ /**
+ * The transformer this will use to transform a
+ * source tree into a result tree.
+ */
TransformerImpl m_transformer;
- /** NEEDSDOC Field m_sourceTreeHandler */
+ /** DOMBuilder object this will use */
private DOMBuilder m_sourceTreeHandler;
- /** NEEDSDOC Field m_root */
+ /** The root of the source document */
private Document m_root; // Normally a Document
- /** NEEDSDOC Field m_initedRoot */
+ /** No longer used?? */
private boolean m_initedRoot;
- /** NEEDSDOC Field m_shouldCheckWhitespace */
+ /** Flag indicating whether we should check whitespaces */
boolean m_shouldCheckWhitespace = false;
/**
* Get the root document of tree that is being or will be created.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Root document
*/
public Node getRoot()
{
@@ -164,7 +168,7 @@
/**
* Set the root document of tree will be created.
*
- * NEEDSDOC @param root
+ * @param root root document of tree that will be created
*/
public void setRoot(Document root)
{
@@ -172,24 +176,24 @@
}
/**
- * NEEDSDOC Method setExceptionThrown
+ * If an exception was thrown, keep track of it
*
*
- * NEEDSDOC @param e
+ * @param e Exception that was thrown
*/
public void setExceptionThrown(Exception e)
{
((DocumentImpl) m_root).m_exceptionThrown = e;
}
- /** NEEDSDOC Field m_inputSource */
+ /** Source Document */
Source m_inputSource;
/**
- * NEEDSDOC Method setInputSource
+ * Set the Source document
*
*
- * NEEDSDOC @param source
+ * @param source source document
*/
public void setInputSource(Source source)
{
@@ -197,10 +201,10 @@
}
/**
- * NEEDSDOC Method getInputSource
+ * Get Source Document.
*
*
- * NEEDSDOC (getInputSource) @return
+ * @return source document
*/
public Source getInputSource()
{
@@ -210,18 +214,21 @@
/**
* Implement the setDocumentLocator event.
*
- * NEEDSDOC @param locator
+ * @param locator Document locator
*/
public void setDocumentLocator(Locator locator){}
- /** NEEDSDOC Field m_useMultiThreading */
+ /**
+ * Flag to indicate whether to use multiple threads for the transformation
+ * and the parse.
+ */
private boolean m_useMultiThreading = false;
/**
* Set whether or not the tree being built should handle
* transformation while the parse is still going on.
*
- * NEEDSDOC @param b
+ * @param b Flag to indicate whether to use multiple threads
*/
public void setUseMultiThreading(boolean b)
{
@@ -232,20 +239,26 @@
* Tell whether or not the tree being built should handle
* transformation while the parse is still going on.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Flag to indicate whether to use multiple threads
*/
public boolean getUseMultiThreading()
{
return m_useMultiThreading;
}
- /** NEEDSDOC Field indexedLookup */
+ /** Flag indicating whether indexed lookup is being used to search the
source tree */
private boolean indexedLookup = false; // for now
- /** NEEDSDOC Field m_eventsCount */
+ /**
+ * Field to hold the number of tasks on the transform thread
+ * so far waiting for a notify() from the parse thread.
+ */
private int m_eventsCount = 0;
- /** NEEDSDOC Field m_maxEventsToNotify */
+ /**
+ * Minimum number of waiting tasks before the transform thread
+ * gets a notify() event.
+ */
private int m_maxEventsToNotify = 18;
/**
@@ -371,10 +384,10 @@
}
/**
- * NEEDSDOC Method printTree
+ * Print the tree starting at the specified node.
*
*
- * NEEDSDOC @param n
+ * @param n A node in a Document.
*/
private void printTree(Node n)
{
@@ -393,10 +406,10 @@
/**
* Implement the startElement event.
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
- * NEEDSDOC @param atts
+ * @param ns Namespace of the element
+ * @param localName Local part of the qualified name of the element
+ * @param name Name of the element
+ * @param atts List of attributes associated with the element
*
* @throws SAXException
*/
@@ -417,9 +430,9 @@
/**
* Implement the endElement event.
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
+ * @param ns Namespace of the element
+ * @param localName Local part of the qualified name of the element
+ * @param name Name of the element
*
* @throws SAXException
*/
@@ -470,9 +483,9 @@
/**
* Implement the characters event.
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch Character array from the characters event
+ * @param start Start index of characters to process in the array
+ * @param length Number of characters to process in the array
*
* @throws SAXException
*/
@@ -497,9 +510,9 @@
/**
* Implement the characters event.
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch Character array from the characters event
+ * @param start Start index of characters to process in the array
+ * @param length Number of characters to process in the array
*
* @throws SAXException
*/
@@ -518,9 +531,9 @@
/**
* Implement the ignorableWhitespace event.
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch Character array from the characters event
+ * @param start Start index of characters to process in the array
+ * @param length Number of characters to process in the array
*
* @throws SAXException
*/
@@ -542,8 +555,8 @@
/**
* Implement the processingInstruction event.
*
- * NEEDSDOC @param target
- * NEEDSDOC @param data
+ * @param target Target of PI node
+ * @param data Content of PI node
*
* @throws SAXException
*/
@@ -744,17 +757,17 @@
*/
public void skippedEntity(String name) throws SAXException{}
- /** NEEDSDOC Field m_shouldStripWS */
+ /** Flag indicating whether to strip whitespace nodes */
private boolean m_shouldStripWS = false;
- /** NEEDSDOC Field m_shouldStripWhitespaceStack */
+ /** Stack of flags indicating whether to strip whitespace nodes */
private BoolStack m_shouldStripWhitespaceStack = new BoolStack();
/**
- * NEEDSDOC Method getShouldStripWhitespace
+ * Find out whether or not to strip whispace nodes.
*
*
- * NEEDSDOC (getShouldStripWhitespace) @return
+ * @return whether or not to strip whispace nodes.
*/
boolean getShouldStripWhitespace()
{
@@ -762,10 +775,10 @@
}
/**
- * NEEDSDOC Method pushShouldStripWhitespace
- *
+ * Set whether to strip whitespaces and push in current value of
+ * m_shouldStripWS in m_shouldStripWhitespaceStack.
*
- * NEEDSDOC @param shouldStrip
+ * @param shouldStrip Flag indicating whether to strip whitespace nodes
*/
void pushShouldStripWhitespace(boolean shouldStrip)
{
@@ -776,7 +789,8 @@
}
/**
- * NEEDSDOC Method popShouldStripWhitespace
+ * Set whether to strip whitespaces at this point by popping out
+ * m_shouldStripWhitespaceStack.
*
*/
void popShouldStripWhitespace()
@@ -785,10 +799,11 @@
}
/**
- * NEEDSDOC Method setShouldStripWhitespace
+ * Set whether to strip whitespaces and set the top of the stack to
+ * the current value of m_shouldStripWS.
*
*
- * NEEDSDOC @param shouldStrip
+ * @param shouldStrip Flag indicating whether to strip whitespace nodes
*/
void setShouldStripWhitespace(boolean shouldStrip)
{
1.4 +32 -27
xml-xalan/java/src/org/apache/xalan/stree/StreeDOMBuilder.java
Index: StreeDOMBuilder.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/StreeDOMBuilder.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- StreeDOMBuilder.java 2000/11/06 17:44:57 1.3
+++ StreeDOMBuilder.java 2000/11/08 20:45:14 1.4
@@ -67,20 +67,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class StreeDOMBuilder <needs-comment/>
+ * This class takes SAX events (in addition to some extra events
+ * that SAX doesn't handle yet) and adds the result to a document
+ * or document fragment.
*/
public class StreeDOMBuilder extends DOMBuilder
{
- /** NEEDSDOC Field m_docImpl */
+ /** Source document node */
protected DocumentImpl m_docImpl;
/**
* StreeDOMBuilder instance constructor... it will add the DOM nodes
* to the document fragment.
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param node
+ * @param doc Root node of DOM being created
+ * @param node Node currently being processed
*/
public StreeDOMBuilder(Document doc, Node node)
{
@@ -94,8 +96,8 @@
* StreeDOMBuilder instance constructor... it will add the DOM nodes
* to the document fragment.
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param docFrag
+ * @param doc Root node of DOM being created
+ * @param docFrag Document fragment node of DOM being created
*/
public StreeDOMBuilder(Document doc, DocumentFragment docFrag)
{
@@ -109,7 +111,7 @@
* StreeDOMBuilder instance constructor... it will add the DOM nodes
* to the document.
*
- * NEEDSDOC @param doc
+ * @param doc Root node of DOM being created
*/
public StreeDOMBuilder(Document doc)
{
@@ -131,12 +133,12 @@
}
/**
- * NEEDSDOC Method characters
+ * Receive notification of character data.
*
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch The characters from the XML document.
+ * @param start The start position in the array.
+ * @param length The number of characters to read from the array.
*
* @throws SAXException
*/
@@ -150,12 +152,12 @@
}
/**
- * NEEDSDOC Method ignorableWhitespace
+ * Receive notification of ignorable whitespace in element content.
*
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch The characters from the XML document.
+ * @param start The start position in the array.
+ * @param length The number of characters to read from the array.
*
* @throws SAXException
*/
@@ -166,12 +168,15 @@
}
/**
- * NEEDSDOC Method charactersRaw
+ * If available, when the disable-output-escaping attribute is used,
+ * output raw text without escaping. A PI will be inserted in front
+ * of the node with the name "lotusxsl-next-is-raw" and a value of
+ * "formatter-to-dom".
*
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch The characters from the XML document.
+ * @param start The start position in the array.
+ * @param length The number of characters to read from the array.
*
* @throws SAXException
*/
@@ -185,12 +190,12 @@
}
/**
- * NEEDSDOC Method comment
+ * Report an XML comment anywhere in the document.
*
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch An array holding the characters in the comment.
+ * @param start The starting position in the array.
+ * @param length The number of characters to use from the array.
*
* @throws SAXException
*/
@@ -200,12 +205,12 @@
}
/**
- * NEEDSDOC Method cdata
+ * Receive notification of cdata.
*
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch The characters from the XML document.
+ * @param start The start position in the array.
+ * @param length The number of characters to read from the array.
*
* @throws SAXException
*/
1.8 +17 -7
xml-xalan/java/src/org/apache/xalan/stree/StreeDOMHelper.java
Index: StreeDOMHelper.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/StreeDOMHelper.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- StreeDOMHelper.java 2000/10/30 18:43:54 1.7
+++ StreeDOMHelper.java 2000/11/08 20:45:15 1.8
@@ -63,7 +63,9 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class StreeDOMHelper <needs-comment/>
+ * Provides XSLTProcessor an interface to the Xerces XML parser. This
+ * liaison should be used if Xerces DOM nodes are being process as
+ * the source tree or as the result tree.
*/
public class StreeDOMHelper extends DOM2Helper
{
@@ -74,12 +76,20 @@
* NEEDSDOC @param node
*
* NEEDSDOC ($objectName$) @return
- */
+ *
// public Document createDocument()
// {
// return new DocumentImpl();
- // }
+ // }*/
+
+ /**
+ * Get the specified node's position in the document
+ *
+ * @param node A node in the document tree
+ *
+ * @return The position of the node in the document
+ */
public String getUniqueID(Node node)
{
@@ -99,9 +109,9 @@
* <meta name="usage" content="internal"/>
* Get the depth level of this node in the tree.
*
- * NEEDSDOC @param node1
+ * @param node1 A node in the document tree
*
- * NEEDSDOC ($objectName$) @return
+ * @return The depth level of this node in the tree
*/
public short getLevel(Node node1)
{
@@ -119,9 +129,9 @@
/**
* Tell if the given node is a namespace decl node.
*
- * NEEDSDOC @param n
+ * @param n A node in the document tree
*
- * NEEDSDOC ($objectName$) @return
+ * @return true if the node is a namespace decl node
*/
public boolean isNamespaceNode(Node n)
{
1.5 +23 -23 xml-xalan/java/src/org/apache/xalan/stree/TextImpl.java
Index: TextImpl.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/stree/TextImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TextImpl.java 2000/10/30 18:43:54 1.4
+++ TextImpl.java 2000/11/08 20:45:17 1.5
@@ -66,26 +66,26 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class TextImpl <needs-comment/>
+ * Class to hold information about a Text node.
*/
public class TextImpl extends Child implements Text, SaxEventDispatch
{
- /** NEEDSDOC Field m_data */
+ /** Text from this Text node */
protected String m_data;
- /** NEEDSDOC Field m_start */
+ /** Start of text from this Text node */
protected int m_start;
- /** NEEDSDOC Field m_length */
+ /** Length of text from this text node */
protected int m_length;
/**
* Constructor TextImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param data
+ * @param doc Document object
+ * @param data Text from node
*/
public TextImpl(DocumentImpl doc, String data)
{
@@ -101,10 +101,10 @@
* Constructor TextImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param doc Document object
+ * @param ch Array containing text from node
+ * @param start Start location of text in array
+ * @param length Length of text in array
*/
public TextImpl(DocumentImpl doc, char ch[], int start, int length)
{
@@ -121,10 +121,10 @@
}
/**
- * NEEDSDOC Method dispatchSaxEvent
+ * Handle a Characters event
*
*
- * NEEDSDOC @param ch
+ * @param ch Content handler to handle SAX events
*
* @throws SAXException
*/
@@ -141,7 +141,7 @@
* A short integer indicating what type of node this is. The named
* constants for this value are defined in the org.w3c.dom.Node interface.
*
- * NEEDSDOC ($objectName$) @return
+ * @return TEXT_NODE node type
*/
public short getNodeType()
{
@@ -151,7 +151,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Text node name
*/
public String getNodeName()
{
@@ -165,7 +165,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return Text node name
*/
public String getLocalName()
{
@@ -176,7 +176,7 @@
* Retrieve character data currently stored in this node.
*
*
- * NEEDSDOC ($objectName$) @return
+ * @return Text from this text node
* @throws DOMExcpetion(DOMSTRING_SIZE_ERR) In some implementations,
* the stored data may exceed the permitted length of strings. If so,
* getData() will throw this DOMException advising the user to
@@ -195,7 +195,7 @@
* Report number of characters currently stored in this node's
* data. It may be 0, meaning that the value is an empty string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return number of characters in this node's data.
*/
public int getLength()
{
@@ -203,10 +203,10 @@
}
/**
- * NEEDSDOC Method getNodeValue
+ * Return the text that constitutes this node's data.
*
*
- * NEEDSDOC (getNodeValue) @return
+ * @return this node's data
*/
public String getNodeValue()
{
@@ -218,13 +218,13 @@
}
/**
- * NEEDSDOC Method supports
+ * Find out if a given feature is supported
*
*
- * NEEDSDOC @param feature
- * NEEDSDOC @param version
+ * @param feature Feature to check
+ * @param version Version to check
*
- * NEEDSDOC (supports) @return
+ * @return true if feature is SaxEventDispatch.SUPPORTSINTERFACE
*/
public boolean supports(String feature, String version)
{
1.5 +12 -12 xml-xalan/java/src/org/apache/xalan/stree/WhiteSpace.java
Index: WhiteSpace.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/WhiteSpace.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- WhiteSpace.java 2000/10/30 18:43:54 1.4
+++ WhiteSpace.java 2000/11/08 20:45:18 1.5
@@ -67,17 +67,17 @@
public class WhiteSpace extends Child
{
- /** NEEDSDOC Field m_data */
+ /** White space data */
String m_data;
/**
* Constructor WhiteSpace
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param doc Document object
+ * @param ch Array containing whitespace data
+ * @param start Start of data in array
+ * @param length Length of data in array
*/
public WhiteSpace(DocumentImpl doc, char ch[], int start, int length)
{
@@ -91,7 +91,7 @@
* A short integer indicating what type of node this is. The named
* constants for this value are defined in the org.w3c.dom.Node interface.
*
- * NEEDSDOC ($objectName$) @return
+ * @return TEXT_NODE node type
*/
public short getNodeType()
{
@@ -101,7 +101,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Text node name
*/
public String getNodeName()
{
@@ -115,7 +115,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return Text node name
*/
public String getLocalName()
{
@@ -126,7 +126,7 @@
* Retrieve character data currently stored in this node.
*
*
- * NEEDSDOC ($objectName$) @return
+ * @return Text associated with this node
* @throws DOMExcpetion(DOMSTRING_SIZE_ERR) In some implementations,
* the stored data may exceed the permitted length of strings. If so,
* getData() will throw this DOMException advising the user to
@@ -141,7 +141,7 @@
* Report number of characters currently stored in this node's
* data. It may be 0, meaning that the value is an empty string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Length of text associated with this node
*/
public int getLength()
{
@@ -149,10 +149,10 @@
}
/**
- * NEEDSDOC Method getNodeValue
+ * Text associated with this node
*
*
- * NEEDSDOC (getNodeValue) @return
+ * @return Text associated with this node
*/
public String getNodeValue()
{
