mmidy 00/12/13 14:26:52
Modified: java/src/org/apache/xalan/trace PrintTraceListener.java
SelectionEvent.java TraceManager.java
Log:
Javadoc updates
Revision Changes Path
1.5 +1 -1
xml-xalan/java/src/org/apache/xalan/trace/PrintTraceListener.java
Index: PrintTraceListener.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/trace/PrintTraceListener.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PrintTraceListener.java 2000/11/13 16:27:18 1.4
+++ PrintTraceListener.java 2000/12/13 22:26:50 1.5
@@ -80,7 +80,7 @@
/**
* Construct a trace listener.
*
- * NEEDSDOC @param pw
+ * @param pw PrintWriter to use for tracing events
*/
public PrintTraceListener(java.io.PrintWriter pw)
{
1.5 +5 -5
xml-xalan/java/src/org/apache/xalan/trace/SelectionEvent.java
Index: SelectionEvent.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/trace/SelectionEvent.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SelectionEvent.java 2000/11/03 23:28:11 1.4
+++ SelectionEvent.java 2000/12/13 22:26:51 1.5
@@ -102,15 +102,15 @@
/**
* Create an event originating at the given node of the style tree.
+ *
* @param processor The XSLT TransformerFactory.
* @param sourceNode The current context node.
* @param mode The current mode.
- * @param m_styleNode node in the style tree reference for the event.
+ * @param styleNode node in the style tree reference for the event.
* Should not be null. That is not enforced.
- * NEEDSDOC @param styleNode
- * NEEDSDOC @param attributeName
- * NEEDSDOC @param xpath
- * NEEDSDOC @param selection
+ * @param attributeName The attribute name from which the selection is
made.
+ * @param xpath The XPath that executed the selection.
+ * @param selection The result of the selection.
*/
public SelectionEvent(TransformerImpl processor, Node sourceNode,
ElemTemplateElement styleNode, String attributeName,
1.7 +14 -14
xml-xalan/java/src/org/apache/xalan/trace/TraceManager.java
Index: TraceManager.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/trace/TraceManager.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- TraceManager.java 2000/11/23 04:58:12 1.6
+++ TraceManager.java 2000/12/13 22:26:51 1.7
@@ -74,13 +74,13 @@
public class TraceManager
{
- /** NEEDSDOC Field m_transformer */
+ /** A transformer instance */
private TransformerImpl m_transformer;
/**
* Constructor for the trace manager.
*
- * NEEDSDOC @param transformer
+ * @param transformer a non-null instance of a transformer
*/
public TraceManager(TransformerImpl transformer)
{
@@ -127,7 +127,7 @@
/**
* Fire a generate event.
*
- * NEEDSDOC @param te
+ * @param te Generate Event to fire
*/
public void fireGenerateEvent(GenerateEvent te)
{
@@ -148,7 +148,7 @@
/**
* Tell if trace listeners are present.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if there are trace listeners
*/
public boolean hasTraceListeners()
{
@@ -158,9 +158,9 @@
/**
* Fire a trace event.
*
- * NEEDSDOC @param sourceNode
- * NEEDSDOC @param mode
- * NEEDSDOC @param styleNode
+ * @param sourceNode Current source node
+ * @param mode Template mode
+ * @param styleNode Stylesheet template node
*/
public void fireTraceEvent(Node sourceNode, QName mode,
ElemTemplateElement styleNode)
@@ -176,7 +176,7 @@
/**
* Fire a trace event.
*
- * NEEDSDOC @param te
+ * @param te Trace event to fire
*/
public void fireTraceEvent(TracerEvent te)
{
@@ -197,11 +197,11 @@
/**
* Fire a selection event.
*
- * NEEDSDOC @param sourceNode
- * NEEDSDOC @param styleNode
- * NEEDSDOC @param attributeName
- * NEEDSDOC @param xpath
- * NEEDSDOC @param selection
+ * @param sourceNode Current source node
+ * @param styleNode node in the style tree reference for the event.
+ * @param attributeName The attribute name from which the selection is
made.
+ * @param xpath The XPath that executed the selection.
+ * @param selection The result of the selection.
*
* @throws javax.xml.transform.TransformerException
*/
@@ -219,7 +219,7 @@
/**
* Fire a selection event.
*
- * NEEDSDOC @param se
+ * @param se Selection event to fire
*
* @throws javax.xml.transform.TransformerException
*/
