mmidy 00/11/30 12:14:18
Modified: java/src/org/apache/xml/utils AttList.java BoolStack.java
DOMBuilder.java ElemDesc.java IntStack.java
IntVector.java
Log:
Update javadoc
Revision Changes Path
1.2 +24 -25 xml-xalan/java/src/org/apache/xml/utils/AttList.java
Index: AttList.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/AttList.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AttList.java 2000/11/23 04:58:45 1.1
+++ AttList.java 2000/11/30 20:13:56 1.2
@@ -70,23 +70,23 @@
public class AttList implements Attributes
{
- /** NEEDSDOC Field m_attrs */
+ /** List of attribute nodes */
NamedNodeMap m_attrs;
- /** NEEDSDOC Field m_lastIndex */
+ /** Index of last attribute node */
int m_lastIndex;
// ARGHH!! JAXP Uses Xerces without setting the namespace processing to
ON!
// DOM2Helper m_dh = new DOM2Helper();
- /** NEEDSDOC Field m_dh */
+ /** Local reference to DOMHelper */
DOMHelper m_dh;
/**
* Constructor AttList
*
*
- * NEEDSDOC @param attrs
+ * @param attrs List of attributes this will contain
*/
public AttList(NamedNodeMap attrs)
{
@@ -100,8 +100,8 @@
* Constructor AttList
*
*
- * NEEDSDOC @param attrs
- * NEEDSDOC @param dh
+ * @param attrs List of attributes this will contain
+ * @param dh DOMHelper
*/
public AttList(NamedNodeMap attrs, DOMHelper dh)
{
@@ -112,10 +112,10 @@
}
/**
- * NEEDSDOC Method getLength
+ * Get the number of attribute nodes in the list
*
*
- * NEEDSDOC (getLength) @return
+ * @return number of attribute nodes
*/
public int getLength()
{
@@ -149,12 +149,12 @@
}
/**
- * NEEDSDOC Method getQName
+ * Look up an attribute's qualified name by index.
*
*
- * NEEDSDOC @param i
+ * @param index The attribute index (zero-based).
*
- * NEEDSDOC (getQName) @return
+ * @return The attribute's qualified name
*/
public String getQName(int i)
{
@@ -162,12 +162,12 @@
}
/**
- * NEEDSDOC Method getType
+ * Get the attribute's node type by index
*
*
- * NEEDSDOC @param i
+ * @param index The attribute index (zero-based)
*
- * NEEDSDOC (getType) @return
+ * @return the attribute's node type
*/
public String getType(int i)
{
@@ -175,12 +175,12 @@
}
/**
- * NEEDSDOC Method getValue
+ * Get the attribute's node value by index
*
*
- * NEEDSDOC @param i
+ * @param index The attribute index (zero-based)
*
- * NEEDSDOC (getValue) @return
+ * @return the attribute's node value
*/
public String getValue(int i)
{
@@ -188,12 +188,12 @@
}
/**
- * NEEDSDOC Method getType
+ * Get the attribute's node type by name
*
*
- * NEEDSDOC @param name
+ * @param name Attribute name
*
- * NEEDSDOC (getType) @return
+ * @return the attribute's node type
*/
public String getType(String name)
{
@@ -216,12 +216,12 @@
}
/**
- * NEEDSDOC Method getValue
+ * Look up an attribute's value by name.
*
*
- * NEEDSDOC @param name
+ * @param name The attribute node's name
*
- * NEEDSDOC (getValue) @return
+ * @return The attribute node's value
*/
public String getValue(String name)
{
@@ -247,8 +247,7 @@
*
* @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.
*/
1.2 +11 -11 xml-xalan/java/src/org/apache/xml/utils/BoolStack.java
Index: BoolStack.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/BoolStack.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BoolStack.java 2000/11/23 04:58:45 1.1
+++ BoolStack.java 2000/11/30 20:13:58 1.2
@@ -65,13 +65,13 @@
public final class BoolStack
{
- /** NEEDSDOC Field m_values[] */
+ /** Array of boolean values */
private boolean m_values[];
- /** NEEDSDOC Field m_allocatedSize */
+ /** Array size allocated */
private int m_allocatedSize;
- /** NEEDSDOC Field m_index */
+ /** Index into the array of booleans */
private int m_index;
/**
@@ -86,7 +86,7 @@
/**
* Construct a IntVector, using the given block size.
*
- * NEEDSDOC @param size
+ * @param size array size to allocate
*/
public BoolStack(int size)
{
@@ -99,7 +99,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Current length of the list
*/
public final int size()
{
@@ -109,9 +109,8 @@
/**
* Pushes an item onto the top of this stack.
*
- * @param i the int to be pushed onto this stack.
*
- * NEEDSDOC @param val
+ * @param val the boolean to be pushed onto this stack.
* @return the <code>item</code> argument.
*/
public final boolean push(boolean val)
@@ -136,10 +135,11 @@
}
/**
- * NEEDSDOC Method popAndTop
+ * Removes the object at the top of this stack and returns the
+ * next object at the top as the value of this function.
*
*
- * NEEDSDOC (popAndTop) @return
+ * @return Next object to the top or false if none there
*/
public final boolean popAndTop()
{
@@ -150,10 +150,10 @@
}
/**
- * NEEDSDOC Method setTop
+ * Set the item at the top of this stack
*
*
- * NEEDSDOC @param b
+ * @param b Object to set at the top of this stack
*/
public final void setTop(boolean b)
{
1.2 +24 -24 xml-xalan/java/src/org/apache/xml/utils/DOMBuilder.java
Index: DOMBuilder.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/DOMBuilder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMBuilder.java 2000/11/23 04:58:45 1.1
+++ DOMBuilder.java 2000/11/30 20:13:59 1.2
@@ -77,24 +77,24 @@
implements ContentHandler, LexicalHandler
{
- /** NEEDSDOC Field m_doc */
+ /** Root document */
public Document m_doc;
- /** NEEDSDOC Field m_currentNode */
+ /** Current node */
Node m_currentNode = null;
- /** NEEDSDOC Field m_docFrag */
+ /** First node of document fragment or null if not a DocumentFragment
*/
public DocumentFragment m_docFrag = null;
- /** NEEDSDOC Field m_elemStack */
+ /** Vector of element nodes */
NodeVector m_elemStack = new NodeVector();
/**
* DOMBuilder instance constructor... it will add the DOM nodes
* to the document fragment.
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param node
+ * @param doc Root document
+ * @param node Current node
*/
public DOMBuilder(Document doc, Node node)
{
@@ -106,8 +106,8 @@
* DOMBuilder instance constructor... it will add the DOM nodes
* to the document fragment.
*
- * NEEDSDOC @param doc
- * NEEDSDOC @param docFrag
+ * @param doc Root document
+ * @param docFrag Document fragment
*/
public DOMBuilder(Document doc, DocumentFragment docFrag)
{
@@ -119,7 +119,7 @@
* DOMBuilder instance constructor... it will add the DOM nodes
* to the document.
*
- * NEEDSDOC @param doc
+ * @param doc Root document
*/
public DOMBuilder(Document doc)
{
@@ -130,7 +130,7 @@
* Get the root node of the DOM being created. This
* is either a Document or a DocumentFragment.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The root document or document fragment if not null
*/
public Node getRootNode()
{
@@ -140,7 +140,7 @@
/**
* Get the node currently being processed.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the current node being processed
*/
public Node getCurrentNode()
{
@@ -150,7 +150,7 @@
/**
* Return null since there is no Writer for this class.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public java.io.Writer getWriter()
{
@@ -160,7 +160,7 @@
/**
* Append a node to the current container.
*
- * NEEDSDOC @param newNode
+ * @param newNode New node to append
*/
protected void append(Node newNode) throws org.xml.sax.SAXException
{
@@ -285,9 +285,9 @@
* defaulted): #IMPLIED attributes will be omitted.</p>
*
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * @param name The element type name.
+ * @param ns The namespace of the node
+ * @param localName The local part of the qualified name
+ * @param name The element name.
* @param atts The attributes attached to the element, if any.
* @see #endElement
* @see org.xml.sax.Attributes
@@ -352,9 +352,9 @@
* still be attached to the name.</p>
*
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * @param name The element type name
+ * @param ns the namespace of the element
+ * @param localName The local part of the qualified name of the element
+ * @param name The element name
*/
public void endElement(String ns, String localName, String name)
throws org.xml.sax.SAXException
@@ -419,9 +419,9 @@
* 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 Array containing the characters
+ * @param start Index to start of characters in the array
+ * @param length Number of characters in the array
*/
public void charactersRaw(char ch[], int start, int length)
throws org.xml.sax.SAXException
@@ -466,7 +466,7 @@
/**
* Receive notivication of a entityReference.
*
- * NEEDSDOC @param name
+ * @param name name of the entity reference
*/
public void entityReference(String name) throws org.xml.sax.SAXException
{
@@ -541,7 +541,7 @@
append(m_doc.createComment(new String(ch, start, length)));
}
- /** NEEDSDOC Field m_inCData */
+ /** Flag indicating that we are processing a CData section */
protected boolean m_inCData = false;
/**
1.2 +36 -35 xml-xalan/java/src/org/apache/xml/utils/ElemDesc.java
Index: ElemDesc.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/ElemDesc.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ElemDesc.java 2000/11/23 04:58:45 1.1
+++ ElemDesc.java 2000/11/30 20:14:00 1.2
@@ -66,86 +66,86 @@
class ElemDesc
{
- /** NEEDSDOC Field m_flags */
+ /** Element's flags (See below for posible values */
int m_flags;
- /** NEEDSDOC Field m_attrs */
+ /** Table of attributes for the element */
Hashtable m_attrs = null;
- /** NEEDSDOC Field EMPTY */
+ /** EMPTY flag */
static final int EMPTY = (1 << 1);
- /** NEEDSDOC Field FLOW */
+ /** FLOW flag */
static final int FLOW = (1 << 2);
- /** NEEDSDOC Field BLOCK */
+ /** BLOCK flag */
static final int BLOCK = (1 << 3);
- /** NEEDSDOC Field BLOCKFORM */
+ /** BLOCKFORM flag */
static final int BLOCKFORM = (1 << 4);
- /** NEEDSDOC Field BLOCKFORMFIELDSET */
+ /** BLOCKFORMFIELDSET flag */
static final int BLOCKFORMFIELDSET = (1 << 5);
- /** NEEDSDOC Field CDATA */
+ /** CDATA flag */
static final int CDATA = (1 << 6);
- /** NEEDSDOC Field PCDATA */
+ /** PCDATA flag */
static final int PCDATA = (1 << 7);
- /** NEEDSDOC Field RAW */
+ /** RAW flag */
static final int RAW = (1 << 8);
- /** NEEDSDOC Field INLINE */
+ /** INLINE flag */
static final int INLINE = (1 << 9);
- /** NEEDSDOC Field INLINEA */
+ /** INLINEA flag */
static final int INLINEA = (1 << 10);
- /** NEEDSDOC Field INLINELABEL */
+ /** INLINELABEL flag */
static final int INLINELABEL = (1 << 11);
- /** NEEDSDOC Field FONTSTYLE */
+ /** FONTSTYLE flag */
static final int FONTSTYLE = (1 << 12);
- /** NEEDSDOC Field PHRASE */
+ /** PHRASE flag */
static final int PHRASE = (1 << 13);
- /** NEEDSDOC Field FORMCTRL */
+ /** FORMCTRL flag */
static final int FORMCTRL = (1 << 14);
- /** NEEDSDOC Field SPECIAL */
+ /** SPECIAL flag */
static final int SPECIAL = (1 << 15);
- /** NEEDSDOC Field ASPECIAL */
+ /** ASPECIAL flag */
static final int ASPECIAL = (1 << 16);
- /** NEEDSDOC Field HEADMISC */
+ /** HEADMISC flag */
static final int HEADMISC = (1 << 17);
- /** NEEDSDOC Field HEAD */
+ /** HEAD flag */
static final int HEAD = (1 << 18);
- /** NEEDSDOC Field LIST */
+ /** LIST flag */
static final int LIST = (1 << 19);
- /** NEEDSDOC Field PREFORMATTED */
+ /** PREFORMATTED flag */
static final int PREFORMATTED = (1 << 20);
- /** NEEDSDOC Field WHITESPACESENSITIVE */
+ /** WHITESPACESENSITIVE flag */
static final int WHITESPACESENSITIVE = (1 << 21);
- /** NEEDSDOC Field ATTRURL */
+ /** ATTRURL flag */
static final int ATTRURL = (1 << 1);
- /** NEEDSDOC Field ATTREMPTY */
+ /** ATTREMPTY flag */
static final int ATTREMPTY = (1 << 2);
/**
* Constructor ElemDesc
*
*
- * NEEDSDOC @param flags
+ * @param flags Element flags
*/
ElemDesc(int flags)
{
@@ -156,9 +156,9 @@
* NEEDSDOC Method is
*
*
- * NEEDSDOC @param flags
+ * @param flags flags to compare this element to
*
- * NEEDSDOC (is) @return
+ * @return true if these flags match the element's
*/
boolean is(int flags)
{
@@ -168,11 +168,11 @@
}
/**
- * NEEDSDOC Method setAttr
+ * Set a new attribute for this element
*
*
- * NEEDSDOC @param name
- * NEEDSDOC @param flags
+ * @param name Attribute name
+ * @param flags Attibute flags
*/
void setAttr(String name, int flags)
{
@@ -184,13 +184,14 @@
}
/**
- * NEEDSDOC Method isAttrFlagSet
+ * Find out if a flag is set in a given attribute of this element
*
*
- * NEEDSDOC @param name
- * NEEDSDOC @param flags
+ * @param name Attribute name
+ * @param flags Flag to check
*
- * NEEDSDOC (isAttrFlagSet) @return
+ * @return True if the flag is set in the attribute. Returns false
+ * if the attribute is not found
*/
boolean isAttrFlagSet(String name, int flags)
{
1.2 +2 -2 xml-xalan/java/src/org/apache/xml/utils/IntStack.java
Index: IntStack.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/IntStack.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IntStack.java 2000/11/23 04:58:45 1.1
+++ IntStack.java 2000/11/30 20:14:01 1.2
@@ -77,7 +77,7 @@
/**
* Construct a IntVector, using the given block size.
*
- * NEEDSDOC @param blocksize
+ * @param blocksize Size of block to allocate
*/
public IntStack(int blocksize)
{
@@ -147,7 +147,7 @@
* Sets an object at a the top of the statck
*
*
- * NEEDSDOC @param val
+ * @param val object to set at the top
* @exception EmptyStackException if this stack is empty.
*/
public void setTop(int val)
1.2 +22 -22 xml-xalan/java/src/org/apache/xml/utils/IntVector.java
Index: IntVector.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/IntVector.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IntVector.java 2000/11/23 04:58:45 1.1
+++ IntVector.java 2000/11/30 20:14:02 1.2
@@ -63,16 +63,16 @@
public class IntVector
{
- /** NEEDSDOC Field m_blocksize */
+ /** Size of blocks to allocate */
protected int m_blocksize;
- /** NEEDSDOC Field m_map[] */
+ /** Array of ints */
public int m_map[]; // expose to package for direct access.
- /** NEEDSDOC Field m_firstFree */
+ /** Number of ints in array */
protected int m_firstFree = 0;
- /** NEEDSDOC Field m_mapSize */
+ /** Size of array */
protected int m_mapSize;
/**
@@ -90,7 +90,7 @@
/**
* Construct a IntVector, using the given block size.
*
- * NEEDSDOC @param blocksize
+ * @param blocksize Size of block to allocate
*/
public IntVector(int blocksize)
{
@@ -103,7 +103,7 @@
/**
* Get the length of the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return length of the list
*/
public final int size()
{
@@ -113,7 +113,7 @@
/**
* Append a int onto the vector.
*
- * NEEDSDOC @param value
+ * @param value Int to add to the list
*/
public final void addElement(int value)
{
@@ -140,8 +140,8 @@
* the specified index is shifted upward to have an index one greater
* than the value it had previously.
*
- * NEEDSDOC @param value
- * NEEDSDOC @param at
+ * @param value Int to insert
+ * @param at Index of where to insert
*/
public final void insertElementAt(int value, int at)
{
@@ -191,9 +191,9 @@
* downward to have an index one smaller than the value it had
* previously.
*
- * NEEDSDOC @param s
+ * @param s Int to remove from array
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the int was removed, false if it was not found
*/
public final boolean removeElement(int s)
{
@@ -222,7 +222,7 @@
* index is shifted downward to have an index one smaller than
* the value it had previously.
*
- * NEEDSDOC @param i
+ * @param i index of where to remove and int
*/
public final void removeElementAt(int i)
{
@@ -242,8 +242,8 @@
* The index must be a value greater than or equal to 0 and less
* than the current size of the vector.
*
- * NEEDSDOC @param node
- * NEEDSDOC @param index
+ * @param node object to set
+ * @param index Index of where to set the object
*/
public final void setElementAt(int node, int index)
{
@@ -253,9 +253,9 @@
/**
* Get the nth element.
*
- * NEEDSDOC @param i
+ * @param i index of object to get
*
- * NEEDSDOC ($objectName$) @return
+ * @return object at given index
*/
public final int elementAt(int i)
{
@@ -265,9 +265,9 @@
/**
* Tell if the table contains the given node.
*
- * NEEDSDOC @param s
+ * @param s object to look for
*
- * NEEDSDOC ($objectName$) @return
+ * @return true if the object is in the list
*/
public final boolean contains(int s)
{
@@ -286,8 +286,8 @@
* beginning the search at index, and testing for equality
* using the equals method.
*
- * NEEDSDOC @param elem
- * NEEDSDOC @param index
+ * @param elem object to look for
+ * @param index Index of where to begin search
* @return the index of the first occurrence of the object
* argument in this vector at position index or later in the
* vector; returns -1 if the object is not found.
@@ -309,7 +309,7 @@
* beginning the search at index, and testing for equality
* using the equals method.
*
- * NEEDSDOC @param elem
+ * @param elem object to look for
* @return the index of the first occurrence of the object
* argument in this vector at position index or later in the
* vector; returns -1 if the object is not found.
@@ -331,7 +331,7 @@
* beginning the search at index, and testing for equality
* using the equals method.
*
- * NEEDSDOC @param elem
+ * @param elem Object to look for
* @return the index of the first occurrence of the object
* argument in this vector at position index or later in the
* vector; returns -1 if the object is not found.
