You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by mm...@locus.apache.org on 2000/12/12 22:33:02 UTC
cvs commit: xml-xalan/java/src/org/apache/xalan/transformer ClonerToResultTree.java Counter.java CountersTable.java DecimalToRoman.java MsgMgr.java NodeSortKey.java NodeSorter.java NumeratorFormatter.java QueuedEvents.java
mmidy 00/12/12 13:33:01
Modified: java/src/org/apache/xalan/transformer
ClonerToResultTree.java Counter.java
CountersTable.java DecimalToRoman.java MsgMgr.java
NodeSortKey.java NodeSorter.java
NumeratorFormatter.java QueuedEvents.java
Log:
javadoc updates
Revision Changes Path
1.6 +10 -8 xml-xalan/java/src/org/apache/xalan/transformer/ClonerToResultTree.java
Index: ClonerToResultTree.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/ClonerToResultTree.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ClonerToResultTree.java 2000/11/13 16:27:19 1.5
+++ ClonerToResultTree.java 2000/12/12 21:32:55 1.6
@@ -75,23 +75,24 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class ClonerToResultTree <needs-comment/>
+ * Class used to clone a node, possibly including its children to
+ * a result tree.
*/
public class ClonerToResultTree
{
- /** NEEDSDOC Field m_rth */
+ /** Result tree handler for the cloned tree */
private ResultTreeHandler m_rth;
- /** NEEDSDOC Field m_transformer */
+ /** Transformer instance to use for cloning */
private TransformerImpl m_transformer;
/**
* Constructor ClonerToResultTree
*
*
- * NEEDSDOC @param transformer
- * NEEDSDOC @param rth
+ * @param transformer non-null transformer instance to use for the cloning
+ * @param rth non-null result tree handler for the cloned tree
*/
public ClonerToResultTree(TransformerImpl transformer,
ResultTreeHandler rth)
@@ -105,9 +106,10 @@
* TODO: Fix or figure out node clone failure!
* the error condition is severe enough to halt processing.
*
- * NEEDSDOC @param node
- * NEEDSDOC @param shouldCloneAttributes
- *
+ * @param node The node to clone
+ * @param shouldCloneAttributes Flag indicating whether to
+ * clone children attributes
+ *
* @throws TransformerException
*/
public void cloneToResultTree(Node node, boolean shouldCloneAttributes)
1.6 +7 -8 xml-xalan/java/src/org/apache/xalan/transformer/Counter.java
Index: Counter.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/Counter.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Counter.java 2000/11/23 04:58:14 1.5
+++ Counter.java 2000/12/12 21:32:55 1.6
@@ -119,8 +119,8 @@
/**
* Construct a counter object.
*
- * NEEDSDOC @param numberElem
- * NEEDSDOC @param countNodes
+ * @param numberElem The owning xsl:number element.
+ * @param countNodes A vector of all nodes counted so far.
*
* @throws TransformerException
*/
@@ -133,7 +133,7 @@
/**
* Construct a counter object.
*
- * NEEDSDOC @param numberElem
+ * @param numberElem The owning xsl:number element.
*
* @throws TransformerException
*/
@@ -146,11 +146,10 @@
* Try and find a node that was previously counted. If found,
* return a positive integer that corresponds to the count.
*
- * NEEDSDOC @param support
+ * @param support The XPath context to use
* @param node The node to be counted.
- * @returns The count of the node, or -1 if not found.
- *
- * NEEDSDOC ($objectName$) @return
+ *
+ * @return The count of the node, or -1 if not found.
*/
int getPreviouslyCounted(XPathContext support, Node node)
{
@@ -185,7 +184,7 @@
/**
* Get the last node in the list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the last node in the list.
*/
Node getLast()
{
1.5 +13 -11 xml-xalan/java/src/org/apache/xalan/transformer/CountersTable.java
Index: CountersTable.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/CountersTable.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CountersTable.java 2000/11/13 16:27:19 1.4
+++ CountersTable.java 2000/12/12 21:32:56 1.5
@@ -87,9 +87,10 @@
* Get the list of counters that corresponds to
* the given ElemNumber object.
*
- * NEEDSDOC @param numberElem
+ * @param numberElem the given xsl:number element.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the list of counters that corresponds to
+ * the given ElemNumber object.
*/
Vector getCounters(ElemNumber numberElem)
{
@@ -103,9 +104,10 @@
* Put a counter into the table and create an empty
* vector as it's value.
*
- * NEEDSDOC @param numberElem
+ * @param numberElem the given xsl:number element.
*
- * NEEDSDOC ($objectName$) @return
+ * @return an empty vector to be used to store counts
+ * for this number element.
*/
Vector putElemNumber(ElemNumber numberElem)
{
@@ -127,8 +129,8 @@
* order, or a list of counted nodes that are in forwards document
* order.
*
- * NEEDSDOC @param flist
- * NEEDSDOC @param blist
+ * @param flist Vector of nodes built in forwards document order
+ * @param blist Vector of nodes built in backwards document order
*/
void appendBtoFList(NodeSet flist, NodeSet blist)
{
@@ -143,17 +145,17 @@
// For diagnostics
- /** NEEDSDOC Field m_countersMade */
+ /** Number of counters created so far */
int m_countersMade = 0;
/**
* Count forward until the given node is found, or until
* we have looked to the given amount.
- * @node The node to count.
*
- * NEEDSDOC @param support
- * NEEDSDOC @param numberElem
- * NEEDSDOC @param node
+ * @param support The XPath context to use
+ * @param numberElem The given xsl:number element.
+ * @param node The node to count.
+ *
* @return The node count, or 0 if not found.
*
* @throws TransformerException
1.3 +10 -8 xml-xalan/java/src/org/apache/xalan/transformer/DecimalToRoman.java
Index: DecimalToRoman.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/DecimalToRoman.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DecimalToRoman.java 2000/10/30 18:56:57 1.2
+++ DecimalToRoman.java 2000/12/12 21:32:56 1.3
@@ -69,10 +69,12 @@
* Constructor DecimalToRoman
*
*
- * NEEDSDOC @param postValue
- * NEEDSDOC @param postLetter
- * NEEDSDOC @param preValue
- * NEEDSDOC @param preLetter
+ * @param postValue Minimum value for a given range of
+ * roman numbers
+ * @param postLetter Correspoding letter (roman) to postValue
+ * @param preValue Value of last prefixed number within
+ * that same range (i.e. IV if postval is 5 (V))
+ * @param preLetter Correspoding letter(roman) to preValue
*/
public DecimalToRoman(long postValue, String postLetter, long preValue,
String preLetter)
@@ -84,15 +86,15 @@
this.m_preLetter = preLetter;
}
- /** NEEDSDOC Field m_postValue */
+ /** Minimum value for a given range of roman numbers */
public long m_postValue;
- /** NEEDSDOC Field m_postLetter */
+ /** Correspoding letter (roman) to m_postValue */
public String m_postLetter;
- /** NEEDSDOC Field m_preValue */
+ /** Value of last prefixed number within that same range */
public long m_preValue;
- /** NEEDSDOC Field m_preLetter */
+ /** Correspoding letter (roman) to m_preValue */
public String m_preLetter;
}
1.7 +37 -36 xml-xalan/java/src/org/apache/xalan/transformer/MsgMgr.java
Index: MsgMgr.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/MsgMgr.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- MsgMgr.java 2000/12/07 21:12:44 1.6
+++ MsgMgr.java 2000/12/12 21:32:56 1.7
@@ -77,25 +77,25 @@
/**
* Create a message manager object.
*
- * NEEDSDOC @param transformer
+ * @param transformer non transformer instance
*/
public MsgMgr(TransformerImpl transformer)
{
m_transformer = transformer;
}
- /** NEEDSDOC Field m_transformer */
+ /** Transformer instance */
private TransformerImpl m_transformer;
- /** NEEDSDOC Field m_XSLMessages */
+ /** XSLMessages instance, sets things up for issuing messages */
private static XSLMessages m_XSLMessages = new XSLMessages();
/**
- * Warn the user of an problem.
+ * Warn the user of a problem.
* This is public for access by extensions.
*
- * NEEDSDOC @param msg
- * NEEDSDOC @param terminate
+ * @param msg The message text to issue
+ * @param terminate Flag indicating whether to terminate this process
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -124,9 +124,9 @@
/**
* <meta name="usage" content="internal"/>
- * Warn the user of an problem.
+ * Warn the user of a problem.
*
- * NEEDSDOC @param msg
+ * @param msg Message text to issue
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -139,10 +139,10 @@
/**
* <meta name="usage" content="internal"/>
- * Warn the user of an problem.
+ * Warn the user of a problem.
*
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param msg Message text to issue
+ * @param args Arguments to pass to the message
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -155,11 +155,12 @@
/**
* <meta name="usage" content="internal"/>
- * Warn the user of an problem.
+ * Warn the user of a problem.
*
- * NEEDSDOC @param styleNode
- * NEEDSDOC @param sourceNode
- * NEEDSDOC @param msg
+ *
+ * @param styleNode Stylesheet node
+ * @param sourceNode Source tree node
+ * @param msg Message text to issue
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -173,12 +174,12 @@
/**
* <meta name="usage" content="internal"/>
- * Warn the user of an problem.
+ * Warn the user of a problem.
*
- * NEEDSDOC @param styleNode
- * NEEDSDOC @param sourceNode
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param styleNode Stylesheet node
+ * @param sourceNode Source tree node
+ * @param msg Message text to issue
+ * @param args Arguments to pass to the message
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -202,7 +203,7 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param msg
+ * @param msg Message text to issue
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -228,7 +229,7 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param msg
+ * @param msg Message text to issue
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -244,8 +245,8 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param msg Message text to issue
+ * @param args Arguments to be passed to the message
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -261,8 +262,8 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param msg
- * NEEDSDOC @param e
+ * @param msg Message text to issue
+ * @param e Exception to throw
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -278,9 +279,9 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
- * NEEDSDOC @param e
+ * @param msg Message text to issue
+ * @param args Arguments to use in message
+ * @param e Exception to throw
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -309,9 +310,9 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param styleNode
- * NEEDSDOC @param sourceNode
- * NEEDSDOC @param msg
+ * @param styleNode Stylesheet node
+ * @param sourceNode Source tree node
+ * @param msg Message text to issue
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -328,10 +329,10 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param styleNode
- * NEEDSDOC @param sourceNode
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param styleNode Stylesheet node
+ * @param sourceNode Source tree node
+ * @param msg Message text to issue
+ * @param args Arguments to use in message
* @exception XSLProcessorException thrown if the active ProblemListener and XPathContext decide
* the error condition is severe enough to halt processing.
*
1.6 +15 -15 xml-xalan/java/src/org/apache/xalan/transformer/NodeSortKey.java
Index: NodeSortKey.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/NodeSortKey.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- NodeSortKey.java 2000/11/23 04:58:18 1.5
+++ NodeSortKey.java 2000/12/12 21:32:56 1.6
@@ -71,41 +71,41 @@
class NodeSortKey
{
- /** NEEDSDOC Field m_selectPat */
+ /** Select pattern for this sort key */
XPath m_selectPat;
- /** NEEDSDOC Field m_treatAsNumbers */
+ /** Flag indicating whether to treat thee result as a number */
boolean m_treatAsNumbers;
- /** NEEDSDOC Field m_descending */
+ /** Flag indicating whether to sort in descending order */
boolean m_descending;
- /** NEEDSDOC Field m_caseOrderUpper */
+ /** Flag indicating by case */
boolean m_caseOrderUpper;
- /** NEEDSDOC Field m_col */
+ /** Collator instance */
Collator m_col;
- /** NEEDSDOC Field m_locale */
+ /** Locale we're in */
Locale m_locale;
- /** NEEDSDOC Field m_namespaceContext */
+ /** Prefix resolver to use */
org.apache.xml.utils.PrefixResolver m_namespaceContext;
- /** NEEDSDOC Field m_processor */
+ /** Transformer instance */
TransformerImpl m_processor; // needed for error reporting.
/**
* Constructor NodeSortKey
*
*
- * NEEDSDOC @param transformer
- * NEEDSDOC @param selectPat
- * NEEDSDOC @param treatAsNumbers
- * NEEDSDOC @param descending
- * NEEDSDOC @param langValue
- * NEEDSDOC @param caseOrderUpper
- * NEEDSDOC @param namespaceContext
+ * @param transformer non null transformer instance
+ * @param selectPat Select pattern for this key
+ * @param treatAsNumbers Flag indicating whether the result will be a number
+ * @param descending Flag indicating whether to sort in descending order
+ * @param langValue Lang value to use to get locale
+ * @param caseOrderUpper Flag indicating whether case is relevant
+ * @param namespaceContext Prefix resolver
*
* @throws javax.xml.transform.TransformerException
*/
1.9 +27 -26 xml-xalan/java/src/org/apache/xalan/transformer/NodeSorter.java
Index: NodeSorter.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/NodeSorter.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- NodeSorter.java 2000/11/23 04:58:19 1.8
+++ NodeSorter.java 2000/12/12 21:32:56 1.9
@@ -80,10 +80,10 @@
public class NodeSorter
{
- /** NEEDSDOC Field m_execContext */
+ /** Current XPath context */
XPathContext m_execContext;
- /** NEEDSDOC Field m_keys */
+ /** Vector of NodeSortKeys */
Vector m_keys; // vector of NodeSortKeys
/**
@@ -96,7 +96,7 @@
* so it can know how to get the node data according to
* the proper whitespace rules.
*
- * NEEDSDOC @param p
+ * @param p Xpath context to use
*/
public NodeSorter(XPathContext p)
{
@@ -108,7 +108,7 @@
* the criteria in the keys.
* @param v an vector of Nodes.
* @param keys a vector of NodeSortKeys.
- * NEEDSDOC @param support
+ * @param support XPath context to use
*
* @throws javax.xml.transform.TransformerException
*/
@@ -151,12 +151,12 @@
* Return the results of a compare of two nodes.
* TODO: Optimize compare -- cache the getStringExpr results, key by m_selectPat + hash of node.
*
- * NEEDSDOC @param n1
- * NEEDSDOC @param n2
- * NEEDSDOC @param kIndex
- * NEEDSDOC @param support
+ * @param n1 First node to use in compare
+ * @param n2 Second node to use in compare
+ * @param kIndex Index of NodeSortKey to use for sort
+ * @param support XPath context to use
*
- * NEEDSDOC ($objectName$) @return
+ * @return The results of the compare of the two nodes.
*
* @throws TransformerException
*/
@@ -310,11 +310,11 @@
* maintains the original document order of the input if
* the order isn't changed by the sort.
*
- * NEEDSDOC @param a
- * NEEDSDOC @param b
- * NEEDSDOC @param l
- * NEEDSDOC @param r
- * NEEDSDOC @param support
+ * @param a First vector of nodes to compare
+ * @param b Second vector of nodes to compare
+ * @param l Left boundary of partition
+ * @param r Right boundary of partition
+ * @param support XPath context to use
*
* @throws TransformerException
*/
@@ -399,13 +399,10 @@
* left and highest index or right. The first time you call
* this function it will be with the parameters 0, a.length - 1.
*
- * @param a an integer array
+ * @param v a vector of integers
* @param lo0 left boundary of array partition
* @param hi0 right boundary of array partition
*
- * NEEDSDOC @param v
- * NEEDSDOC @param i
- * NEEDSDOC @param j
*/
/* private void QuickSort2(Vector v, int lo0, int hi0, XPathContext support)
@@ -468,6 +465,10 @@
/**
* Simple function to swap two elements in
* a vector.
+ *
+ * @param v Vector of nodes to swap
+ * @param i Index of first node to swap
+ * @param i Index of second node to swap
*/
private void swap(Vector v, int i, int j)
{
@@ -480,36 +481,36 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class NodeCompareElem <needs-comment/>
+ * This class holds the value(s) from executing the given
+ * node against the sort key(s).
*/
class NodeCompareElem
{
- /** NEEDSDOC Field m_node */
+ /** Current node */
Node m_node;
- // This maxkey value was chosen arbitrarily. We are assuming that the
+ /** This maxkey value was chosen arbitrarily. We are assuming that the
// maxkey + 1 keys will only hit fairly rarely and therefore, we
// will get the node values for those keys dynamically.
-
- /** NEEDSDOC Field maxkey */
+ */
int maxkey = 2;
// Keep this in case we decide to use an array. Right now
// using two variables is cheaper.
//Object[] m_KeyValue = new Object[2];
- /** NEEDSDOC Field m_key1Value */
+ /** Value from first sort key */
Object m_key1Value;
- /** NEEDSDOC Field m_key2Value */
+ /** Value from second sort key */
Object m_key2Value;
/**
* Constructor NodeCompareElem
*
*
- * NEEDSDOC @param node
+ * @param node Current node
*
* @throws javax.xml.transform.TransformerException
*/
1.3 +14 -17 xml-xalan/java/src/org/apache/xalan/transformer/NumeratorFormatter.java
Index: NumeratorFormatter.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/NumeratorFormatter.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NumeratorFormatter.java 2000/10/30 18:56:59 1.2
+++ NumeratorFormatter.java 2000/12/12 21:32:56 1.3
@@ -70,19 +70,19 @@
class NumeratorFormatter
{
- /** NEEDSDOC Field m_xslNumberElement */
+ /** The owning xsl:number element. */
protected Element m_xslNumberElement;
- /** NEEDSDOC Field m_formatTokenizer */
+ /** An instance of a Tokenizer */
NumberFormatStringTokenizer m_formatTokenizer;
- /** NEEDSDOC Field m_locale */
+ /** Locale we need to format in */
Locale m_locale;
- /** NEEDSDOC Field m_formatter */
+ /** An instance of a NumberFormat */
java.text.NumberFormat m_formatter;
- /** NEEDSDOC Field m_processor */
+ /** An instance of a transformer */
TransformerImpl m_processor;
/**
@@ -116,8 +116,8 @@
* format, letter-value, xml:lang, digit-group-sep,
* n-digits-per-group, and sequence-src.
*
- * NEEDSDOC @param xslNumberElement
- * NEEDSDOC @param processor
+ * @param xslNumberElement The given xsl:number element
+ * @param processor a non-null transformer instance
*/
NumeratorFormatter(Element xslNumberElement, TransformerImpl processor)
{
@@ -128,6 +128,7 @@
/**
* Convert a long integer into alphabetic counting, in other words
* count using the sequence A B C ... Z AA AB AC.... etc.
+ *
* @param val Value to convert -- must be greater than zero.
* @param table a table containing one character for each digit in the radix
* @return String representing alpha count of number.
@@ -265,32 +266,28 @@
class NumberFormatStringTokenizer
{
- /** NEEDSDOC Field currentPosition */
+ /** Field holding the current position in the string */
private int currentPosition;
- /** NEEDSDOC Field maxPosition */
+ /** The total length of the string */
private int maxPosition;
- /** NEEDSDOC Field str */
+ /** The string to tokenize */
private String str;
/**
* Construct a NumberFormatStringTokenizer.
*
- * NEEDSDOC @param str
+ * @param str The string to tokenize
*/
NumberFormatStringTokenizer(String str)
{
this.str = str;
maxPosition = str.length();
}
-
- /**
- * Reset tokenizer so that nextToken() starts from the beginning.
- */
-
+
/**
- * NEEDSDOC Method reset
+ * Reset tokenizer so that nextToken() starts from the beginning.
*
*/
void reset()
1.6 +19 -19 xml-xalan/java/src/org/apache/xalan/transformer/QueuedEvents.java
Index: QueuedEvents.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/QueuedEvents.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- QueuedEvents.java 2000/11/23 04:58:19 1.5
+++ QueuedEvents.java 2000/12/12 21:32:57 1.6
@@ -70,19 +70,19 @@
abstract class QueuedEvents
{
- /** NEEDSDOC Field m_eventCount */
+ /** The number of events queued */
int m_eventCount = 0;
- /** NEEDSDOC Field m_startDoc */
+ /** Queued start document */
QueuedStartDocument m_startDoc = new QueuedStartDocument();
- /** NEEDSDOC Field m_startElement */
+ /** Queued start element */
QueuedStartElement m_startElement = new QueuedStartElement();
/**
* Get the queued document event.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the queued document event or null if none.
*/
QueuedStartDocument getQueuedDoc()
{
@@ -92,7 +92,7 @@
/**
* Get the queued document event.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the queued document event.
*/
QueuedStartDocument getQueuedDocAtBottom()
{
@@ -102,7 +102,7 @@
/**
* Get the queued element.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the queued element.
*/
QueuedStartElement getQueuedElem()
{
@@ -112,12 +112,12 @@
/**
* This is for the derived class to init new events.
*
- * NEEDSDOC @param qse
+ * @param qse Queud Sax event
*/
protected abstract void initQSE(QueuedSAXEvent qse);
/**
- * NEEDSDOC Method reInitEvents
+ * To re-initialize the document and element events
*
*/
protected void reInitEvents()
@@ -127,7 +127,7 @@
}
/**
- * NEEDSDOC Method reset
+ * Push document event and re-initialize events
*
*/
public void reset()
@@ -149,13 +149,13 @@
}
/**
- * NEEDSDOC Method pushElementEvent
+ * Push the element event
*
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
- * NEEDSDOC @param atts
+ * @param ns Namespace URI of the element
+ * @param localName Local part of the qualified name of the element
+ * @param name Name of the element
+ * @param atts Attribute children of the element
*/
void pushElementEvent(String ns, String localName, String name,
Attributes atts)
@@ -168,7 +168,7 @@
}
/**
- * NEEDSDOC Method popEvent
+ * Pop element event
*
*/
void popEvent()
@@ -179,14 +179,14 @@
m_eventCount--;
}
- /** NEEDSDOC Field m_serializer */
+ /** Instance of a serializer */
private org.apache.xalan.serialize.Serializer m_serializer;
/**
- * This is only for use of object pooling, so the that
+ * This is only for use of object pooling, so that
* it can be reset.
*
- * NEEDSDOC @param s
+ * @param s non-null instance of a serializer
*/
void setSerializer(org.apache.xalan.serialize.Serializer s)
{
@@ -197,7 +197,7 @@
* This is only for use of object pooling, so the that
* it can be reset.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The serializer
*/
org.apache.xalan.serialize.Serializer getSerializer()
{