sboag 00/12/05 21:32:06
Modified: java/src/org/apache/xml/utils Trie.java
Log:
Javadoc comments.
Revision Changes Path
1.2 +14 -18 xml-xalan/java/src/org/apache/xml/utils/Trie.java
Index: Trie.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/Trie.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Trie.java 2000/11/23 04:58:46 1.1
+++ Trie.java 2000/12/06 05:32:06 1.2
@@ -66,15 +66,14 @@
public class Trie
{
- /** NEEDSDOC Field ALPHA_SIZE */
+ /** Size of the m_nextChar array. */
public static final int ALPHA_SIZE = 128;
- /** NEEDSDOC Field m_Root */
+ /** The root node of the tree. */
Node m_Root;
/**
- * Constructor Trie
- *
+ * Construct the trie.
*/
public Trie()
{
@@ -82,13 +81,12 @@
}
/**
- * NEEDSDOC Method put
- *
+ * Put an object into the trie for lookup.
*
- * NEEDSDOC @param key
- * NEEDSDOC @param value
+ * @param key must be a 7-bit ASCII string
+ * @param value any java object.
*
- * NEEDSDOC (put) @return
+ * @return The old object that matched key, or null.
*/
public Object put(String key, Object value)
{
@@ -126,12 +124,11 @@
}
/**
- * NEEDSDOC Method get
- *
+ * Get an object that matches the key.
*
- * NEEDSDOC @param key
+ * @param key must be a 7-bit ASCII string
*
- * NEEDSDOC (get) @return
+ * @return The object that matches the key, or null.
*/
public Object get(String key)
{
@@ -161,14 +158,13 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class Node <needs-comment/>
+ * The node representation for the trie.
*/
class Node
{
/**
- * Constructor Node
- *
+ * Constructor, creates a Node[ALPHA_SIZE].
*/
Node()
{
@@ -176,10 +172,10 @@
m_Value = null;
}
- /** NEEDSDOC Field m_nextChar[] */
+ /** The next nodes. */
Node m_nextChar[];
- /** NEEDSDOC Field m_Value */
+ /** The value. */
Object m_Value;
}
}
