mmidy 00/11/07 14:23:54
Modified: java/src/org/apache/xalan/stree AttrImpl.java
AttrImplNS.java CDATASectionImpl.java Child.java
CommentImpl.java DOMImplementationImpl.java
DocumentFragmentImpl.java DocumentTypeImpl.java
ElementImpl.java ElementImplWithNS.java
IndexedDocImpl.java IndexedElem.java
IndexedElemImpl.java IndexedElemWithNS.java
IndexedLocPathIterator.java LevelIndexIterator.java
LevelIndexer.java NameSpaceDecl.java
NotationImpl.java
Log:
Documentation changes!!!
Revision Changes Path
1.5 +25 -21 xml-xalan/java/src/org/apache/xalan/stree/AttrImpl.java
Index: AttrImpl.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/stree/AttrImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- AttrImpl.java 2000/10/30 18:43:43 1.4
+++ AttrImpl.java 2000/11/07 22:22:21 1.5
@@ -66,27 +66,30 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class AttrImpl <needs-comment/>
+ * Class to hold information about an attribute node.
*/
public class AttrImpl extends Child implements Attr
{
- /** NEEDSDOC Field m_name */
+ /** Attribute name */
private String m_name;
- /** NEEDSDOC Field m_value */
+ /** Attribute value */
private String m_value;
- /** NEEDSDOC Field m_specified */
+ /**
+ * Flag to determine if this attribute was explicitly given a
+ * value in the original document
+ */
private boolean m_specified = true;
/**
* Constructor AttrImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param name
- * NEEDSDOC @param value
+ * @param doc Document object
+ * @param name Attribute name
+ * @param value Attribute value
*/
AttrImpl(DocumentImpl doc, String name, String value)
{
@@ -101,7 +104,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 node type of attribute
*/
public short getNodeType()
{
@@ -111,7 +114,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return node name
*/
public String getNodeName()
{
@@ -132,7 +135,7 @@
* namespace from the element it is attached to. If an attribute is not
* explicitly given a namespace, it simply has no namespace.
*
- * NEEDSDOC ($objectName$) @return
+ * @return namespace URI
*/
public String getNamespaceURI()
{
@@ -144,7 +147,7 @@
* unspecified.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return namespace prefix of this node
*/
public String getPrefix()
{
@@ -158,7 +161,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return local part of the qualified name of this node
*/
public String getLocalName()
{
@@ -172,7 +175,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return the value of this attribute node
*/
public String getValue()
{
@@ -182,7 +185,7 @@
/**
* Same as getValue().
*
- * NEEDSDOC ($objectName$) @return
+ * @return the value of this attribute node
*
* @throws DOMException
*/
@@ -198,7 +201,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC @param value
+ * @param value Attribute value to be set
*
* @throws DOMException
*/
@@ -228,7 +231,8 @@
* the document and has a value of #IMPLIED in the DTD, then the
* attribute does not appear in the structure model of the document.
*
- * NEEDSDOC ($objectName$) @return
+ * @return whether this attribute was explicitly given a value in the
original
+ * document
*/
public boolean getSpecified()
{
@@ -240,7 +244,7 @@
* <code>null</code> if this attribute is not in use.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return node this attribute is attached to
*/
public Element getOwnerElement()
{
@@ -251,7 +255,7 @@
* NEEDSDOC Method getName
*
*
- * NEEDSDOC (getName) @return
+ * @return attribute name
*/
public String getName()
{
@@ -262,7 +266,7 @@
* NEEDSDOC Method setName
*
*
- * NEEDSDOC @param name
+ * @param name to set attribute name to
*/
void setName(String name)
{
@@ -273,7 +277,7 @@
* The node immediately preceding this node. If there is no such node,
* this returns <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return node immediately preceding this node
*/
public Node getPreviousSibling()
{
@@ -284,7 +288,7 @@
* The node immediately following this node. If there is no such node,
* this returns <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return node immediately following this node
*/
public Node getNextSibling()
{
1.6 +10 -10 xml-xalan/java/src/org/apache/xalan/stree/AttrImplNS.java
Index: AttrImplNS.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/AttrImplNS.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- AttrImplNS.java 2000/10/30 18:43:43 1.5
+++ AttrImplNS.java 2000/11/07 22:22:24 1.6
@@ -62,25 +62,25 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class AttrImplNS <needs-comment/>
+ * Class to hold information about an attribute node with a name space
*/
public class AttrImplNS extends AttrImpl
{
- /** NEEDSDOC Field m_localName */
+ /** Attribute local name */
private String m_localName;
- /** NEEDSDOC Field m_namespaceURI */
+ /** Attribute namespace URI */
private String m_namespaceURI; // attribute index
/**
* Constructor AttrImplNS
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param uri
- * NEEDSDOC @param name
- * NEEDSDOC @param value
+ * @param doc Document object
+ * @param uri Attribute namespace URI
+ * @param name attribute name
+ * @param value Attribute value
*/
AttrImplNS(DocumentImpl doc, String uri, String name, String value)
{
@@ -113,7 +113,7 @@
* namespace from the element it is attached to. If an attribute is not
* explicitly given a namespace, it simply has no namespace.
*
- * NEEDSDOC ($objectName$) @return
+ * @return namespace URI of this node
*/
public String getNamespaceURI()
{
@@ -125,7 +125,7 @@
* unspecified.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return namespace prefix of this node
*/
public String getPrefix()
{
@@ -143,7 +143,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return local part of the qualified name of this node
*/
public String getLocalName()
{
1.5 +12 -12
xml-xalan/java/src/org/apache/xalan/stree/CDATASectionImpl.java
Index: CDATASectionImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/CDATASectionImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CDATASectionImpl.java 2000/10/30 18:43:44 1.4
+++ CDATASectionImpl.java 2000/11/07 22:22:25 1.5
@@ -67,7 +67,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class CDATASectionImpl <needs-comment/>
+ * Class to hold information about a CDATASection node
*/
public class CDATASectionImpl extends TextImpl implements CDATASection
{
@@ -76,8 +76,8 @@
* Constructor CDATASectionImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param data
+ * @param doc Document object
+ * @param data CDATASection data
*/
public CDATASectionImpl(DocumentImpl doc, String data)
{
@@ -88,10 +88,10 @@
* Constructor CDATASectionImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param doc Document object
+ * @param ch Array of characters in CDATASection
+ * @param start Beginning of CDATASection data in the array
+ * @param length Number of characters in CDATASection data in the array
*/
public CDATASectionImpl(DocumentImpl doc, char ch[], int start, int length)
{
@@ -101,7 +101,7 @@
/**
* Returns the node type.
*
- * NEEDSDOC ($objectName$) @return
+ * @return node type
*/
public short getNodeType()
{
@@ -111,7 +111,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return node name
*/
public String getNodeName()
{
@@ -125,7 +125,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return node local name
*/
public String getLocalName()
{
@@ -133,10 +133,10 @@
}
/**
- * NEEDSDOC Method dispatchSaxEvent
+ * Handle a CDATASection SAX event
*
*
- * NEEDSDOC @param ch
+ * @param ch Content Handler
*
* @throws SAXException
*/
1.12 +35 -35 xml-xalan/java/src/org/apache/xalan/stree/Child.java
Index: Child.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/stree/Child.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Child.java 2000/11/06 17:43:49 1.11
+++ Child.java 2000/11/07 22:22:27 1.12
@@ -70,34 +70,34 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class Child <needs-comment/>
+ * Class representing a child node
*/
public class Child extends UnImplNode implements DOMOrder
{
- /** NEEDSDOC Field m_doc */
+ /** Document Object */
protected DocumentImpl m_doc;
- /** NEEDSDOC Field m_parent */
+ /** This child's parent node */
protected Parent m_parent;
- /** NEEDSDOC Field m_next */
+ /** This child next sibling */
Child m_next;
- /** NEEDSDOC Field m_prev */
+ /** This child previous sibling */
Child m_prev;
- /** NEEDSDOC Field m_level */
+ /** This child's level in the source tree */
short m_level;
- /** NEEDSDOC Field m_uid */
+ /** This child's unique ID */
int m_uid;
/**
- * NEEDSDOC Method setDoc
+ * Set the document object for this child
*
*
- * NEEDSDOC @param doc
+ * @param doc document object
*/
protected void setDoc(DocumentImpl doc)
{
@@ -108,7 +108,7 @@
* Constructor Child
*
*
- * NEEDSDOC @param doc
+ * @param doc document object
*/
public Child(DocumentImpl doc)
{
@@ -118,7 +118,7 @@
/**
* Set the parent of the node.
*
- * NEEDSDOC @param parent
+ * @param parent this node's parent
*/
protected void setParent(Parent parent)
{
@@ -150,10 +150,10 @@
public void setComplete(boolean isComplete){}
/**
- * NEEDSDOC Method getTransformer
+ * Get the Transformer object for this source tree.
*
*
- * NEEDSDOC (getTransformer) @return
+ * @return transformer object for this source tree
*/
protected TransformerImpl getTransformer()
{
@@ -161,10 +161,10 @@
}
/**
- * NEEDSDOC Method throwParseError
+ * Throw a Parse Error exception
*
*
- * NEEDSDOC @param e
+ * @param e original exception
*/
protected void throwParseError(Exception e)
{
@@ -172,7 +172,7 @@
}
/**
- * NEEDSDOC Method throwIfParseError
+ * Throw a Parse Error exception if no exception was thrown yet
*
*/
protected void throwIfParseError()
@@ -184,7 +184,7 @@
/**
* Set the UID (document order index).
*
- * NEEDSDOC @param kIndex
+ * @param kIndex Index of this child.
*/
protected void setUid(int kIndex)
{
@@ -194,7 +194,7 @@
/**
* Get the UID (document order index).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Index of this child
*/
public int getUid()
{
@@ -205,7 +205,7 @@
* <meta name="usage" content="internal"/>
* Get the depth level of this node in the tree.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This child's level in the source tree
*/
public short getLevel()
{
@@ -216,7 +216,7 @@
* <meta name="usage" content="internal"/>
* Get the depth level of this node in the tree.
*
- * NEEDSDOC @param level
+ * @param level This child's level in the source tree
*/
public void setLevel(short level)
{
@@ -226,7 +226,7 @@
/**
* Get the root Document Implementation.
*
- * NEEDSDOC ($objectName$) @return
+ * @return document object
*/
DocumentImpl getDocumentImpl()
{
@@ -243,7 +243,7 @@
* tree, or if it has been removed from the tree, this is
* <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's parent node.
*/
public Node getParentNode()
{
@@ -257,7 +257,7 @@
* The first child of this node. If there is no such node, this returns
* <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's first child.
*/
public Node getFirstChild()
{
@@ -268,7 +268,7 @@
* The last child of this node. If there is no such node, this returns
* <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's last child.
*/
public Node getLastChild()
{
@@ -279,7 +279,7 @@
* The node immediately preceding this node. If there is no such node,
* this returns <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's previous sibling
*/
public Node getPreviousSibling()
{
@@ -290,7 +290,7 @@
* The node immediately following this node. If there is no such node,
* this returns <code>null</code>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's next sibling.
*/
public Node getNextSibling()
{
@@ -332,7 +332,7 @@
* <code>null</code>.
* @version DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return document object
*/
public Document getOwnerDocument()
{
@@ -373,7 +373,7 @@
* The namespace URI of this node, or <code>null</code> if it is
* unspecified.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's namespace URI
*/
public String getNamespaceURI()
{
@@ -385,7 +385,7 @@
* unspecified.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's namespace prefix
*/
public String getPrefix()
{
@@ -399,7 +399,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return the local part of the qualified name of this node
*/
public String getLocalName()
{
@@ -409,7 +409,7 @@
/**
* UnImplemented.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getTagName()
{
@@ -419,7 +419,7 @@
/**
* Unimplemented.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public NamedNodeMap getAttributes()
{
@@ -429,8 +429,8 @@
/**
* Unimplemented.
*
- * NEEDSDOC @param name
- * NEEDSDOC @param value
+ * @param name Attribute name
+ * @param value Attribute value
*
* @throws DOMException
*/
@@ -439,7 +439,7 @@
/**
* Tell if the given node is a namespace decl node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return whether this node is a namespace decl node
*/
public boolean isNamespaceNode()
{
1.5 +12 -12
xml-xalan/java/src/org/apache/xalan/stree/CommentImpl.java
Index: CommentImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/CommentImpl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CommentImpl.java 2000/10/30 18:43:44 1.4
+++ CommentImpl.java 2000/11/07 22:22:29 1.5
@@ -67,7 +67,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class CommentImpl <needs-comment/>
+ * Class to hold information about a comment node
*/
public class CommentImpl extends TextImpl implements Comment
{
@@ -76,8 +76,8 @@
* Constructor CommentImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param data
+ * @param doc Document object
+ * @param data Comment data
*/
public CommentImpl(DocumentImpl doc, String data)
{
@@ -88,10 +88,10 @@
* Constructor CommentImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param doc Document object
+ * @param ch Character array of comment data
+ * @param start Beginning of comment data in array
+ * @param length Length of comment data in array
*/
public CommentImpl(DocumentImpl doc, char ch[], int start, int length)
{
@@ -102,7 +102,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 node type
*/
public short getNodeType()
{
@@ -112,7 +112,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return node name
*/
public String getNodeName()
{
@@ -126,7 +126,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return the local part of the qualified name of this node
*/
public String getLocalName()
{
@@ -134,10 +134,10 @@
}
/**
- * NEEDSDOC Method dispatchSaxEvent
+ * Handle a Comment Sax Event
*
*
- * NEEDSDOC @param ch
+ * @param ch Character array with comment data
*
* @throws SAXException
*/
1.3 +5 -5
xml-xalan/java/src/org/apache/xalan/stree/DOMImplementationImpl.java
Index: DOMImplementationImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/DOMImplementationImpl.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DOMImplementationImpl.java 2000/10/30 18:43:45 1.2
+++ DOMImplementationImpl.java 2000/11/07 22:22:30 1.3
@@ -65,7 +65,8 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class DOMImplementationImpl <needs-comment/>
+ * This class provides a number of methods for performing operations that
+ * are independent of any particular instance of the document object model.
*/
public class DOMImplementationImpl extends UnImplNode
implements DOMImplementation
@@ -95,10 +96,9 @@
* This is interpreted as "Version of the DOM API supported for the
* specified Feature", and in Level 1 should be "1.0"
*
- * @returns true iff this implementation is compatable with the
+ * @return true iff this implementation is compatible with the
* specified feature and version.
*
- * NEEDSDOC ($objectName$) @return
*/
public boolean hasFeature(String feature, String version)
{
@@ -121,7 +121,7 @@
/**
* NON-DOM: Obtain and return the single shared object
*
- * NEEDSDOC ($objectName$) @return
+ * @return this DOMImplementation
*/
public static DOMImplementation getDOMImplementation()
{
@@ -138,7 +138,7 @@
* @param systemID The document type system identifier.
* @since WD-DOM-Level-2-19990923
*
- * NEEDSDOC ($objectName$) @return
+ * @return an empty DocumentType node
*/
public DocumentType createDocumentType(String qualifiedName,
String publicID, String systemID)
1.6 +4 -4
xml-xalan/java/src/org/apache/xalan/stree/DocumentFragmentImpl.java
Index: DocumentFragmentImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/DocumentFragmentImpl.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DocumentFragmentImpl.java 2000/10/30 18:43:45 1.5
+++ DocumentFragmentImpl.java 2000/11/07 22:22:32 1.6
@@ -61,7 +61,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class DocumentFragmentImpl <needs-comment/>
+ * Class to hold information about a DocumentFragment node
*/
public class DocumentFragmentImpl extends DocumentImpl
implements DocumentFragment
@@ -83,7 +83,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 node type
*/
public short getNodeType()
{
@@ -93,7 +93,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return node name
*/
public String getNodeName()
{
@@ -107,7 +107,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return the local part of the qualified name of this node
*/
public String getLocalName()
{
1.6 +16 -16
xml-xalan/java/src/org/apache/xalan/stree/DocumentTypeImpl.java
Index: DocumentTypeImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/DocumentTypeImpl.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DocumentTypeImpl.java 2000/10/30 18:43:45 1.5
+++ DocumentTypeImpl.java 2000/11/07 22:22:33 1.6
@@ -62,7 +62,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class DocumentTypeImpl <needs-comment/>
+ * Class to hold information about a DocumentType node
*/
public class DocumentTypeImpl extends Child implements DocumentType
{
@@ -71,8 +71,8 @@
* Constructor DocumentTypeImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param name
+ * @param doc Document Object
+ * @param name Node name
*/
DocumentTypeImpl(DocumentImpl doc, String name)
{
@@ -82,23 +82,23 @@
m_name = name;
}
- /** NEEDSDOC Field m_name */
+ /** DocumentType node name */
private String m_name;
- /** NEEDSDOC Field m_publicID */
+ /** Document Type publicID */
private String m_publicID;
- /** NEEDSDOC Field m_systemID */
+ /** Document Type systemID */
private String m_systemID;
- /** NEEDSDOC Field m_internalSubset */
+ /** Document Type internalSubset */
private String m_internalSubset;
/**
* 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 Document Type node type
*/
public short getNodeType()
{
@@ -108,7 +108,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Document Type node name
*/
public String getNodeName()
{
@@ -119,7 +119,7 @@
* The name of DTD; i.e., the name immediately following the
* <code>DOCTYPE</code> keyword.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Document Type name
*/
public String getName()
{
@@ -133,7 +133,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return Document Type local name
*/
public String getLocalName()
{
@@ -160,7 +160,7 @@
* <br>The DOM Level 2 does not support editing entities, therefore
* <code>entities</code> cannot be altered in any way.
*
- * NEEDSDOC ($objectName$) @return
+ * @return both external and internal entities declared in the DTD
*/
public NamedNodeMap getEntities()
{
@@ -174,7 +174,7 @@
* <br>The DOM Level 2 does not support editing notations, therefore
* <code>notations</code> cannot be altered in any way.
*
- * NEEDSDOC ($objectName$) @return
+ * @return notations declared in the DTD
*/
public NamedNodeMap getNotations()
{
@@ -185,7 +185,7 @@
* The public identifier of the external subset.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return public identifier
*/
public String getPublicId()
{
@@ -196,7 +196,7 @@
* The system identifier of the external subset.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return system identifier
*/
public String getSystemId()
{
@@ -207,7 +207,7 @@
* The internal subset as a string.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return internal subset as a string
*/
public String getInternalSubset()
{
1.19 +40 -41
xml-xalan/java/src/org/apache/xalan/stree/ElementImpl.java
Index: ElementImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/ElementImpl.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- ElementImpl.java 2000/11/06 17:47:48 1.18
+++ ElementImpl.java 2000/11/07 22:22:35 1.19
@@ -68,29 +68,30 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class ElementImpl <needs-comment/>
+ * This class represents an element in an HTML or XML document.
+ * Elements may have attributes associated with them as well as children
nodes.
*/
public class ElementImpl extends Parent implements Attributes, NamedNodeMap
{
- /** NEEDSDOC Field m_name */
+ /** Element name */
private String m_name;
- /** NEEDSDOC Field m_attrsEnd */
+ /** Number of attributes associated with this element */
private short m_attrsEnd = 0;
- /** NEEDSDOC Field m_firstAttr */
+ /** First attribute associated with this element */
private AttrImpl m_firstAttr;
- /** NEEDSDOC Field m_lastAttr */
+ /** Last attribute associated with this element */
private AttrImpl m_lastAttr;
/**
* Constructor ElementImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param name
+ * @param doc Document object
+ * @param name Element name
*/
ElementImpl(DocumentImpl doc, String name)
{
@@ -104,9 +105,9 @@
* Constructor ElementImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param name
- * NEEDSDOC @param atts
+ * @param doc Document Object
+ * @param name Element name
+ * @param atts List of attributes associated with this element
*/
ElementImpl(DocumentImpl doc, String name, Attributes atts)
{
@@ -122,7 +123,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 This node's type
*/
public short getNodeType()
{
@@ -132,7 +133,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's name
*/
public String getNodeName()
{
@@ -146,7 +147,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return the local part of the qualified name of this node
*/
public String getLocalName()
{
@@ -160,7 +161,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return the tag name of this node
*/
public String getTagName()
{
@@ -171,7 +172,7 @@
* Get the nth attribute child.
* @param i the index of the child.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the attribute child at the specified position
* @exception ArrayIndexOutOfBoundsException if the index is out of bounds.
* @exception NullPointerException if there are no children.
*/
@@ -208,7 +209,7 @@
* it is likely that more children will be added.
* DON'T CALL THIS FUNCTION IF YOU CAN HELP IT!!!!!!
*
- * NEEDSDOC ($objectName$) @return
+ * @return the number of children this node currently contains
*/
public int getChildCount()
{
@@ -246,7 +247,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return a NamedNodeMap containing this node's attributes
*/
public NamedNodeMap getAttributes()
{
@@ -260,8 +261,8 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC @param name
- * NEEDSDOC @param value
+ * @param name attribute name
+ * @param value attribute value
*
* @throws DOMException
*/
@@ -280,9 +281,9 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param qualifiedName
- * NEEDSDOC @param value
+ * @param namespaceURI Attribute name space
+ * @param qualifiedName Attribute qualified name
+ * @param value Attribute value
*
* @throws DOMException
*/
@@ -304,7 +305,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC @param atts
+ * @param atts List of attributes to set for this node
*
* @throws DOMException
*/
@@ -339,9 +340,9 @@
/**
* Create an attribute node.
*
- * NEEDSDOC @param name
+ * @param name Attribute name to create
*
- * NEEDSDOC ($objectName$) @return
+ * @return the created attribute object
*
* @throws DOMException
*/
@@ -410,10 +411,10 @@
/**
* Create an attribute node with a namespace .
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param qualifiedName
+ * @param namespaceURI name space of the attribute to create
+ * @param qualifiedName qualified name of the attribute to create
*
- * NEEDSDOC ($objectName$) @return
+ * @return the created attribute object
*
* @throws DOMException
*/
@@ -582,10 +583,8 @@
/**
* Look up an attribute's value by name.
- *
- * @param index The attribute index (zero-based).
- *
- * NEEDSDOC @param name
+ *
+ * @param name The attribute name to look up
* @return The attribute's value as a string, or null if the
* index is out of range.
*/
@@ -603,8 +602,8 @@
*
* @param uri The Namespace URI, or the empty string if
* the name has no Namespace URI.
- * @param localName The attribute's local name.
- * NEEDSDOC @param localPart
+ * @param localPart The attribute's local name.
+ *
* @return The index of the attribute, or -1 if it does not
* appear in the list.
*/
@@ -742,12 +741,12 @@
////////////////////////////
/**
- * NEEDSDOC Method getNamedItem
+ * Get the child attribute with the specified attribute name
*
*
- * NEEDSDOC @param name
+ * @param name Attribute name to look up
*
- * NEEDSDOC (getNamedItem) @return
+ * @return The found attribute node or null if not found
*/
public Node getNamedItem(String name)
{
@@ -809,12 +808,12 @@
}
/**
- * NEEDSDOC Method removeItem
+ * Remove the attribute at the specified index from the attribute list
*
*
- * NEEDSDOC @param index
+ * @param index Position of attribute to remove in attribute list
*
- * NEEDSDOC (removeItem) @return
+ * @return the removed attribute or null if not found
*
* @throws DOMException
*/
@@ -853,7 +852,7 @@
* The range of valid child node indices
* is <code>0</code> to <code>length-1</code> inclusive.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The nunber of attribute nodes associated with this element.
*/
public int getLength()
{
1.4 +16 -14
xml-xalan/java/src/org/apache/xalan/stree/ElementImplWithNS.java
Index: ElementImplWithNS.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/ElementImplWithNS.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ElementImplWithNS.java 2000/10/30 18:43:48 1.3
+++ ElementImplWithNS.java 2000/11/07 22:22:36 1.4
@@ -60,24 +60,26 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class ElementImplWithNS <needs-comment/>
+ * This class represents an element in an HTML or XML document associated
+ * with a given namespace.
+ * Elements may have attributes associated with them as well as children
nodes.
*/
public class ElementImplWithNS extends ElementImpl
{
- /** NEEDSDOC Field m_localName */
+ /** This element's localName */
private String m_localName;
- /** NEEDSDOC Field m_uri */
+ /** This element's namespace URI */
private String m_uri;
/**
* Constructor ElementImplWithNS
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param ns
- * NEEDSDOC @param name
+ * @param doc Document object
+ * @param ns Namespace URI
+ * @param name Element's name
*/
ElementImplWithNS(DocumentImpl doc, String ns, String name)
{
@@ -98,11 +100,11 @@
* Constructor ElementImplWithNS
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
- * NEEDSDOC @param atts
+ * @param doc Document Object
+ * @param ns Element's Namespace URI
+ * @param localName Element's localName
+ * @param name Element's name
+ * @param atts List of attributes associated with this element
*/
ElementImplWithNS(DocumentImpl doc, String ns, String localName,
String name, Attributes atts)
@@ -118,7 +120,7 @@
* The namespace URI of this node, or <code>null</code> if it is
* unspecified.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's namespace URI
*/
public String getNamespaceURI()
{
@@ -130,7 +132,7 @@
* unspecified.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's namespace prefix
*/
public String getPrefix()
{
@@ -148,7 +150,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return the local part of the qualified name of this node
*/
public String getLocalName()
{
1.3 +12 -5
xml-xalan/java/src/org/apache/xalan/stree/IndexedDocImpl.java
Index: IndexedDocImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/IndexedDocImpl.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- IndexedDocImpl.java 2000/10/30 18:43:48 1.2
+++ IndexedDocImpl.java 2000/11/07 22:22:37 1.3
@@ -70,7 +70,10 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class IndexedDocImpl <needs-comment/>
+ * This is the implementation of the DOM2 Document
+ * interface. It rules over the tree, and may contain
+ * common information for the tree.
+ * Used for indexed look up.
*/
public class IndexedDocImpl extends DocumentImpl implements IndexedElem
{
@@ -88,21 +91,25 @@
* Constructor IndexedDocImpl
*
*
- * NEEDSDOC @param doctype
+ * @param doctype The DocumentType reference that
+ * this tree conforms to.
*/
IndexedDocImpl(DocumentType doctype)
{
super(doctype);
}
- /** NEEDSDOC Field m_index */
+ /**
+ * An integer indicating where this node's children can
+ * be found in the indexed nodes list.
+ */
private int m_index;
/**
* An integer indicating where this node's children can
* be found in the indexed nodes list.
*
- * NEEDSDOC @param anIndex
+ * @param anIndex index to set in nodes list
*/
public void setIndex(int anIndex)
{
@@ -113,7 +120,7 @@
* An integer indicating where this node's children can
* be found in the indexed nodes list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return index of this nodes's children in nodes list
*/
public int getIndex()
{
1.3 +3 -3
xml-xalan/java/src/org/apache/xalan/stree/IndexedElem.java
Index: IndexedElem.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/IndexedElem.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- IndexedElem.java 2000/10/30 18:43:49 1.2
+++ IndexedElem.java 2000/11/07 22:22:39 1.3
@@ -66,7 +66,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Interface IndexedElem
+ * Interface implemented by Elements in indexed lookup
*/
public interface IndexedElem
{
@@ -75,7 +75,7 @@
* An integer indicating where this node's children can
* be found in the indexed nodes list.
*
- * NEEDSDOC @param anIndex
+ * @param anIndex Index in nodes list of this node's children to set
*/
public void setIndex(int anIndex);
@@ -83,7 +83,7 @@
* An integer indicating where this node's children can
* be found in the indexed nodes list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Index in nodes list of this node's children
*/
public int getIndex();
}
1.4 +16 -11
xml-xalan/java/src/org/apache/xalan/stree/IndexedElemImpl.java
Index: IndexedElemImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/IndexedElemImpl.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- IndexedElemImpl.java 2000/10/30 18:43:49 1.3
+++ IndexedElemImpl.java 2000/11/07 22:22:44 1.4
@@ -66,26 +66,31 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class IndexedElemImpl <needs-comment/>
+ * This class represents an element in an HTML or XML document.
+ * Elements may have attributes associated with them as well as children
nodes.
+ * Used in Indexed lookup.
*/
public class IndexedElemImpl extends ElementImpl implements IndexedElem
{
- /** NEEDSDOC Field m_name */
+ /** Element name */
private String m_name;
- /** NEEDSDOC Field m_attrsEnd */
+ /** Number of attributes for this element */
private short m_attrsEnd;
- /** NEEDSDOC Field m_index */
+ /**
+ * An integer indicating where this node's children can
+ * be found in the indexed nodes list.
+ */
private int m_index;
/**
* Constructor IndexedElemImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param name
+ * @param doc Document Object
+ * @param name Element name
*/
IndexedElemImpl(DocumentImpl doc, String name)
{
@@ -96,9 +101,9 @@
* Constructor IndexedElemImpl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param name
- * NEEDSDOC @param atts
+ * @param doc Document object
+ * @param name Element name
+ * @param atts List of attributes associated with this element
*/
IndexedElemImpl(DocumentImpl doc, String name, Attributes atts)
{
@@ -109,7 +114,7 @@
* An integer indicating where this node's children can
* be found in the indexed nodes list.
*
- * NEEDSDOC @param anIndex
+ * @param anIndex Index of this nodes children in node list to set
*/
public void setIndex(int anIndex)
{
@@ -120,7 +125,7 @@
* An integer indicating where this node's children can
* be found in the indexed nodes list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Index of this nodes children in node list
*/
public int getIndex()
{
1.4 +20 -14
xml-xalan/java/src/org/apache/xalan/stree/IndexedElemWithNS.java
Index: IndexedElemWithNS.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/IndexedElemWithNS.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- IndexedElemWithNS.java 2000/10/30 18:43:49 1.3
+++ IndexedElemWithNS.java 2000/11/07 22:22:47 1.4
@@ -60,28 +60,34 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class IndexedElemWithNS <needs-comment/>
+ * * This class represents an element in an HTML or XML document associated
+ * with a given namespace.
+ * Elements may have attributes associated with them as well as children
nodes.
+ * Used in Indexed lookup.
*/
public class IndexedElemWithNS extends ElementImplWithNS
implements IndexedElem
{
- /** NEEDSDOC Field m_localName */
+ /** Element's localName */
private String m_localName;
- /** NEEDSDOC Field m_uri */
+ /** Element's namespace URI */
private String m_uri;
- /** NEEDSDOC Field m_index */
+ /**
+ * An integer indicating where this node's children can
+ * be found in the indexed nodes list.
+ */
private int m_index;
/**
* Constructor IndexedElemWithNS
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param ns
- * NEEDSDOC @param name
+ * @param doc Document Element
+ * @param ns Element's namespace URI
+ * @param name Element's name
*/
IndexedElemWithNS(DocumentImpl doc, String ns, String name)
{
@@ -92,11 +98,11 @@
* Constructor IndexedElemWithNS
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
- * NEEDSDOC @param atts
+ * @param doc Document Element
+ * @param ns Element's namespace URI
+ * @param localName Element's local name
+ * @param name Element's name
+ * @param atts List of attributes associated with this element
*/
IndexedElemWithNS(DocumentImpl doc, String ns, String localName,
String name, Attributes atts)
@@ -108,7 +114,7 @@
* An integer indicating where this node's children can
* be found in the indexed nodes list.
*
- * NEEDSDOC @param anIndex
+ * @param anIndex Index of this node's children in nodes list to be set
*/
public void setIndex(int anIndex)
{
@@ -119,7 +125,7 @@
* An integer indicating where this node's children can
* be found in the indexed nodes list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Index of this node's children in nodes list
*/
public int getIndex()
{
1.4 +2 -2
xml-xalan/java/src/org/apache/xalan/stree/IndexedLocPathIterator.java
Index: IndexedLocPathIterator.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/IndexedLocPathIterator.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- IndexedLocPathIterator.java 2000/10/30 18:43:50 1.3
+++ IndexedLocPathIterator.java 2000/11/07 22:22:48 1.4
@@ -90,8 +90,8 @@
/**
* Create a IndexedLocPathIterator object.
*
- * NEEDSDOC @param compiler
- * NEEDSDOC @param opPos
+ * @param compiler Compiler for this iterator
+ * @param opPos Position in OPMAP
*
* @throws org.xml.sax.SAXException
*/
1.3 +4 -4
xml-xalan/java/src/org/apache/xalan/stree/LevelIndexIterator.java
Index: LevelIndexIterator.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/LevelIndexIterator.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- LevelIndexIterator.java 2000/10/30 18:43:51 1.2
+++ LevelIndexIterator.java 2000/11/07 22:22:51 1.3
@@ -76,10 +76,10 @@
/**
*
- * NEEDSDOC @param parent
- * NEEDSDOC @param type
- * NEEDSDOC @param url
- * NEEDSDOC @param name
+ * @param parent Parent node
+ * @param type Node type
+ * @param url Node's namespace URI
+ * @param name Node's name
*/
public LevelIndexIterator(Node parent, int type, String url, String name){}
1.4 +46 -45
xml-xalan/java/src/org/apache/xalan/stree/LevelIndexer.java
Index: LevelIndexer.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/LevelIndexer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- LevelIndexer.java 2000/10/30 18:43:51 1.3
+++ LevelIndexer.java 2000/11/07 22:22:53 1.4
@@ -79,27 +79,26 @@
*/
public class LevelIndexer
{
-
- /** NEEDSDOC Field lastUsed */
- int lastUsed;
-
- /** NEEDSDOC Field m_subtype */
+
+ /**
+ * Global variable to store the subtype of the elements
+ * added to the table of nodes
+ */
int m_subtype;
- /** NEEDSDOC Field m_defaultSize */
+ /** Default size of a nodesList to be added to the level array
*/
int m_defaultSize = 3; // this is the default value.
-
- // change this to be new object extending from hashtable...
- //Hashtable
- /** NEEDSDOC Field m_elemTypes */
- MultiKeyTable m_elemTypes = new MultiKeyTable(); //array of element types
+ /**
+ * Hashtable of element types that is keyed
+ * on multiple keys.
+ */
+ MultiKeyTable m_elemTypes = new MultiKeyTable();
- /* Array of levels in the tree.
+ /**
+ * Array of levels in the tree.
* Each element of this array is a nodesList element.
*/
-
- /** NEEDSDOC Field m_levelArray */
Object[] m_levelArray; // array of levels in the tree. These are used
// to build the elemPostings table.
@@ -116,7 +115,7 @@
* <meta name="usage" content="internal"/>
* Insert a node in the nodesList by level, by parent and by type.
*
- * NEEDSDOC @param child
+ * @param child Node to be inserted in nodesList
*/
public void insertNode(Child child)
{
@@ -231,9 +230,9 @@
* <meta name="usage" content="internal"/>
* Get a list of nodes in the level array by level and by type.
*
- * NEEDSDOC @param level
+ * @param level Level of the nodes in the document tree
*
- * NEEDSDOC ($objectName$) @return
+ * @return List of nodes at the given level in the document tree.
*/
public Object[] getNodesList(int level)
{
@@ -250,9 +249,9 @@
* <meta name="usage" content="internal"/>
* Get a list of nodes in the level array by level and by type.
*
- * NEEDSDOC @param nodesList
+ * @param nodesList Existing list of nodes to expand
*
- * NEEDSDOC ($objectName$) @return
+ * @return Larger list of nodes, including the nodes from original list
*/
public Object[] allocateNewList(Object[] nodesList)
{
@@ -274,11 +273,11 @@
* <meta name="usage" content="internal"/>
* Get index pointing to nodes of a certain type in the nodeslist.
*
- * NEEDSDOC @param child
- * NEEDSDOC @param type
- * NEEDSDOC @param nodesList
+ * @param child Node for which type we're looking for an index
+ * @param type Type of node to look for in nodesList
+ * @param nodesList List of nodes at a certain level in document tree
*
- * NEEDSDOC ($objectName$) @return
+ * @return index pointing to nodes of a certain type in the given nodeslist
*/
public int getIndexForType(Node child, int type, Object[] nodesList)
{
@@ -324,7 +323,7 @@
* Note that m_subtype is a global variable that gets incremented
* for the next time it is used.
*
- * NEEDSDOC @param child
+ * @param child Node to be added to the subtypes table.
* @return return the element subtype
*/
public int addToTable(Child child)
@@ -355,13 +354,13 @@
/**
* <meta name="usage" content="internal"/>
- * Get type.
+ * Get subtype of a given node.
*
- * NEEDSDOC @param name
- * NEEDSDOC @param namespace
- * NEEDSDOC @param prepend
+ * @param name Node name
+ * @param namespace Namespace of node
+ * @param prepend String prepended to attribute node names.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Subtype for the given node.
*/
public short getType(String name, String namespace, String prepend)
{
@@ -373,11 +372,11 @@
/**
* <meta name="usage" content="internal"/>
- * Get type.
+ * Get subtype of a given node.
*
- * NEEDSDOC @param node
+ * @param node Node which subtype we're looking for.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Subtype for the given node.
*/
public short getType(Node node)
{
@@ -400,7 +399,9 @@
*/
static final int MAXDEPTH = 2000;
- /** NEEDSDOC Field TYPEANY */
+ /**
+ * The value to use for wildcards and the like
+ */
static final int TYPEANY = 2000;
/**
@@ -419,20 +420,20 @@
super();
}
- /** NEEDSDOC Field m_nameTable */
+ /** Hashtable keyed by node name */
private Hashtable m_nameTable;
- /** NEEDSDOC Field m_uriTable */
+ /** Hashtable keyed by namespaceURI */
private Hashtable m_uriTable;
/**
- * NEEDSDOC Method put
+ * Add a node to this table.
*
*
- * NEEDSDOC @param name
- * NEEDSDOC @param namespace
- * NEEDSDOC @param prepend
- * NEEDSDOC @param value
+ * @param name Name of the node
+ * @param namespace namespace of the node
+ * @param prepend String to prepend for attribute nodes
+ * @param value Node subtype
*/
public void put(String name, String namespace, String prepend, int value)
{
@@ -472,14 +473,14 @@
}
/**
- * NEEDSDOC Method get
+ * Get the subtype of a node from the table
*
*
- * NEEDSDOC @param name
- * NEEDSDOC @param namespace
- * NEEDSDOC @param prepend
+ * @param name Node name to look up
+ * @param namespace Namespace of node to look up
+ * @param prepend String that was prepended to the node name
*
- * NEEDSDOC (get) @return
+ * @return The subtype for the given node
*/
public int get(String name, String namespace, String prepend)
{
1.5 +6 -6
xml-xalan/java/src/org/apache/xalan/stree/NameSpaceDecl.java
Index: NameSpaceDecl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/NameSpaceDecl.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- NameSpaceDecl.java 2000/10/30 18:43:51 1.4
+++ NameSpaceDecl.java 2000/11/07 22:22:54 1.5
@@ -58,7 +58,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class NameSpaceDecl <needs-comment/>
+ * Class to represent NameSpace Decl nodes
*/
public class NameSpaceDecl extends AttrImplNS
{
@@ -67,10 +67,10 @@
* Constructor NameSpaceDecl
*
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param uri
- * NEEDSDOC @param name
- * NEEDSDOC @param value
+ * @param doc Document Object
+ * @param uri Namespace URI
+ * @param name Node name
+ * @param value Node value
*/
NameSpaceDecl(DocumentImpl doc, String uri, String name, String value)
{
@@ -80,7 +80,7 @@
/**
* Tell if the given node is a namespace decl node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return true if the node is a namespace decl node
*/
public boolean isNamespaceNode()
{
1.4 +7 -7
xml-xalan/java/src/org/apache/xalan/stree/NotationImpl.java
Index: NotationImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/stree/NotationImpl.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- NotationImpl.java 2000/10/30 18:43:52 1.3
+++ NotationImpl.java 2000/11/07 22:22:56 1.4
@@ -60,12 +60,12 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class NotationImpl <needs-comment/>
+ * Class to represent Notation nodes
*/
public class NotationImpl
{
- /** NEEDSDOC Field m_name */
+ /** Notation Node name */
private String m_name;
/** Public identifier. */
@@ -78,7 +78,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 Node type
*/
public short getNodeType()
{
@@ -89,7 +89,7 @@
* The Public Identifier for this Notation. If no public identifier
* was specified, this will be null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Public identifier of null if none specified.
*/
public String getPublicId()
{
@@ -100,7 +100,7 @@
* The System Identifier for this Notation. If no system identifier
* was specified, this will be null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return System identifier of null if none specified.
*/
public String getSystemId()
{
@@ -110,7 +110,7 @@
/**
* Returns the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Notation Node name
*/
public String getNodeName()
{
@@ -124,7 +124,7 @@
* it is <code>null</code>.
* @since DOM Level 2
*
- * NEEDSDOC ($objectName$) @return
+ * @return Local part of the qualified name of the Notation Node
*/
public String getLocalName()
{
