You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by mc...@apache.org on 2005/01/23 01:37:17 UTC
cvs commit: xml-xalan/java/src/org/apache/xalan/xsltc/runtime AbstractTranslet.java
mcnamara 2005/01/22 16:37:17
Modified: java/src/org/apache/xalan/trace EndSelectionEvent.java
SelectionEvent.java TraceListenerEx3.java
TraceManager.java TracerEvent.java
java/src/org/apache/xalan/transformer KeyIterator.java
KeyRefIterator.java KeyTable.java StackGuard.java
TransformerIdentityImpl.java TransformerImpl.java
TrAXFilter.java
java/src/org/apache/xalan/xsltc/cmdline/getopt GetOpt.java
java/src/org/apache/xalan/xsltc/compiler Parser.java
Pattern.java
java/src/org/apache/xalan/xsltc/dom DOMWSFilter.java
java/src/org/apache/xalan/xsltc/runtime
AbstractTranslet.java
Log:
Clean up javadoc to reduce warnings during doc builds. See XALANJ-2048
Revision Changes Path
1.7 +1 -2 xml-xalan/java/src/org/apache/xalan/trace/EndSelectionEvent.java
Index: EndSelectionEvent.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/trace/EndSelectionEvent.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- EndSelectionEvent.java 16 Feb 2004 23:00:27 -0000 1.6
+++ EndSelectionEvent.java 23 Jan 2005 00:37:16 -0000 1.7
@@ -38,7 +38,6 @@
*
* @param processor The XSLT TransformerFactory.
* @param sourceNode The current context node.
- * @param mode The current mode.
* @param styleNode node in the style tree reference for the event.
* Should not be null. That is not enforced.
* @param attributeName The attribute name from which the selection is made.
1.10 +1 -2 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.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- SelectionEvent.java 16 Feb 2004 23:00:27 -0000 1.9
+++ SelectionEvent.java 23 Jan 2005 00:37:16 -0000 1.10
@@ -67,7 +67,6 @@
*
* @param processor The XSLT TransformerFactory.
* @param sourceNode The current context node.
- * @param mode The current mode.
* @param styleNode node in the style tree reference for the event.
* Should not be null. That is not enforced.
* @param attributeName The attribute name from which the selection is made.
1.4 +3 -3 xml-xalan/java/src/org/apache/xalan/trace/TraceListenerEx3.java
Index: TraceListenerEx3.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/trace/TraceListenerEx3.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TraceListenerEx3.java 16 Feb 2004 23:00:27 -0000 1.3
+++ TraceListenerEx3.java 23 Jan 2005 00:37:16 -0000 1.4
@@ -29,7 +29,7 @@
* Method that is called when an extension event occurs.
* The method is blocking. It must return before processing continues.
*
- * @param ev the extension event.
+ * @param ee the extension event.
*/
public void extension(ExtensionEvent ee);
@@ -37,7 +37,7 @@
* Method that is called when the end of an extension event occurs.
* The method is blocking. It must return before processing continues.
*
- * @param ev the extension event.
+ * @param ee the extension event.
*/
public void extensionEnd(ExtensionEvent ee);
1.19 +1 -5 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.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- TraceManager.java 15 Dec 2004 17:35:38 -0000 1.18
+++ TraceManager.java 23 Jan 2005 00:37:16 -0000 1.19
@@ -124,8 +124,6 @@
/**
* Fire a trace event.
*
- * @param sourceNode Current source node
- * @param mode Template mode
* @param styleNode Stylesheet template node
*/
public void fireTraceEvent(ElemTemplateElement styleNode)
@@ -146,8 +144,6 @@
* Fire a end trace event, after all children of an element have been
* executed.
*
- * @param sourceNode Current source node
- * @param mode Template mode
* @param styleNode Stylesheet template node
*/
public void fireTraceEndEvent(ElemTemplateElement styleNode)
1.10 +1 -3 xml-xalan/java/src/org/apache/xalan/trace/TracerEvent.java
Index: TracerEvent.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/trace/TracerEvent.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- TracerEvent.java 16 Feb 2004 23:00:27 -0000 1.9
+++ TracerEvent.java 23 Jan 2005 00:37:16 -0000 1.10
@@ -60,8 +60,6 @@
* @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.
- * Should not be null. That is not enforced.
* @param styleNode The stylesheet element that is executing.
*/
public TracerEvent(TransformerImpl processor, Node sourceNode, QName mode,
1.18 +2 -6 xml-xalan/java/src/org/apache/xalan/transformer/KeyIterator.java
Index: KeyIterator.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/KeyIterator.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- KeyIterator.java 17 Aug 2004 18:37:32 -0000 1.17
+++ KeyIterator.java 23 Jan 2005 00:37:17 -0000 1.18
@@ -74,10 +74,6 @@
/**
* Create a KeyIterator object.
*
- * @param compiler A reference to the Compiler that contains the op map.
- * @param opPos The position within the op map, which contains the
- * location path expression for this itterator.
- *
* @throws javax.xml.transform.TransformerException
*/
KeyIterator(QName name, Vector keyDeclarations)
@@ -94,7 +90,7 @@
* implementation of TreeWalker and NodeIterator; it is not intended to
* be called directly from user code.
*
- * @param testnode The node to check to see if it passes the filter or not.
+ * @param testNode The node to check to see if it passes the filter or not.
*
* @return a constant to determine whether the node is accepted,
* rejected, or skipped, as defined above .
1.19 +2 -2 xml-xalan/java/src/org/apache/xalan/transformer/KeyRefIterator.java
Index: KeyRefIterator.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/KeyRefIterator.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- KeyRefIterator.java 17 Aug 2004 18:37:32 -0000 1.18
+++ KeyRefIterator.java 23 Jan 2005 00:37:17 -0000 1.19
@@ -81,7 +81,7 @@
* implementation of TreeWalker and NodeIterator; it is not intended to
* be called directly from user code.
*
- * @param testnode The node to check to see if it passes the filter or not.
+ * @param testNode The node to check to see if it passes the filter or not.
*
* @return a constant to determine whether the node is accepted,
* rejected, or skipped, as defined above .
1.19 +1 -2 xml-xalan/java/src/org/apache/xalan/transformer/KeyTable.java
Index: KeyTable.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/KeyTable.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- KeyTable.java 19 Nov 2004 16:36:17 -0000 1.18
+++ KeyTable.java 23 Jan 2005 00:37:17 -0000 1.19
@@ -87,7 +87,6 @@
* @param nscontext The stylesheet's namespace context.
* @param name The key name
* @param keyDeclarations The stylesheet's xsl:key declarations.
- * @param xmlLiaison The parser liaison for support of getNodeData(useNode).
*
* @throws javax.xml.transform.TransformerException
*/
1.14 +1 -11 xml-xalan/java/src/org/apache/xalan/transformer/StackGuard.java
Index: StackGuard.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/StackGuard.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- StackGuard.java 15 Dec 2004 17:35:38 -0000 1.13
+++ StackGuard.java 23 Jan 2005 00:37:17 -0000 1.14
@@ -82,9 +82,6 @@
/**
* Constructor StackGuard
*
- *
- * @param xslTemplate Current template node
- * @param sourceXML Source Node
*/
public StackGuard(TransformerImpl transformerImpl)
{
@@ -94,10 +91,6 @@
/**
* Overide equal method for StackGuard objects
*
- *
- * @param obj StackGuard object to compare
- *
- * @return True if the given object matches this StackGuard object
*/
public int countLikeTemplates(ElemTemplate templ, int pos)
{
@@ -139,9 +132,6 @@
/**
* Check if we are in an infinite loop
- *
- *
- * @param guard Current StackGuard object (matching current template)
*
* @throws TransformerException
*/
1.32 +1 -2 xml-xalan/java/src/org/apache/xalan/transformer/TransformerIdentityImpl.java
Index: TransformerIdentityImpl.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/TransformerIdentityImpl.java,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- TransformerIdentityImpl.java 23 Feb 2004 21:33:14 -0000 1.31
+++ TransformerIdentityImpl.java 23 Jan 2005 00:37:17 -0000 1.32
@@ -1036,7 +1036,6 @@
* performed.
* @param qName The qualified name (with prefix), or the
* empty string if qualified names are not available.
- * @param attributes The specified or defaulted attributes.
*
* @throws org.xml.sax.SAXException Any SAX exception, possibly
* wrapping another exception.
1.161 +1 -20 xml-xalan/java/src/org/apache/xalan/transformer/TransformerImpl.java
Index: TransformerImpl.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/TransformerImpl.java,v
retrieving revision 1.160
retrieving revision 1.161
diff -u -r1.160 -r1.161
--- TransformerImpl.java 15 Dec 2004 17:35:38 -0000 1.160
+++ TransformerImpl.java 23 Jan 2005 00:37:17 -0000 1.161
@@ -1254,7 +1254,6 @@
* feature.
* %REVIEW% Do we need a Node version of this?
* @param node The input source node, which can be any valid DTM node.
- * @param outputTarget The output source target.
*
* @throws TransformerException
*/
@@ -1675,13 +1674,6 @@
* these will not be additive, they will replace the existing
* set of parameters.
*
- * @param name The name of the parameter,
- * which may have a namespace URI.
- * @param value The value object. This can be any valid Java object
- * -- it's up to the processor to provide the proper
- * coersion to the object, or simply pass it on for use
- * in extensions.
- *
* NEEDSDOC @param params
*/
public void setParameters(Properties params)
@@ -1810,8 +1802,6 @@
/**
* Set the content event handler.
*
- * @param resolver The new content handler.
- *
* NEEDSDOC @param handler
* @throws java.lang.NullPointerException If the handler
* is null.
@@ -1994,9 +1984,6 @@
*
* @param elem The parent element whose children will be output
* as a string.
- * @param transformer The XSLT transformer instance.
- * @param sourceNode The current source node context.
- * @param mode The current xslt mode.
*
* @return The stringized result of executing the elements children.
*
@@ -2085,7 +2072,6 @@
* @param xslInstruction The calling element.
* @param template The template to use if xsl:for-each, current template for apply-imports, or null.
* @param child The source context node.
- * @param mode The current mode, may be null.
* @throws TransformerException
* @return true if applied a template, false if not.
* @xsl.usage advanced
@@ -2265,7 +2251,6 @@
*
* @param elem The ElemTemplateElement that contains the children
* that should execute.
- * @param sourceNode The current context node.
* NEEDSDOC @param context
* @param mode The current mode.
* @param handler The ContentHandler to where the result events
@@ -2302,12 +2287,8 @@
/**
* Execute each of the children of a template element.
*
- * @param transformer The XSLT transformer instance.
- *
* @param elem The ElemTemplateElement that contains the children
* that should execute.
- * @param sourceNode The current context node.
- * @param mode The current mode.
* @param shouldAddAttrs true if xsl:attributes should be executed.
*
* @throws TransformerException
1.16 +2 -2 xml-xalan/java/src/org/apache/xalan/transformer/TrAXFilter.java
Index: TrAXFilter.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/TrAXFilter.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- TrAXFilter.java 23 Feb 2004 17:09:48 -0000 1.15
+++ TrAXFilter.java 23 Jan 2005 00:37:17 -0000 1.16
@@ -205,7 +205,7 @@
/**
* Set the content event handler.
*
- * @param resolver The new content handler.
+ * @param handler The new content handler.
* @throws java.lang.NullPointerException If the handler
* is null.
* @see org.xml.sax.XMLReader#setContentHandler
1.6 +1 -4 xml-xalan/java/src/org/apache/xalan/xsltc/cmdline/getopt/GetOpt.java
Index: GetOpt.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/xsltc/cmdline/getopt/GetOpt.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- GetOpt.java 16 Feb 2004 21:21:06 -0000 1.5
+++ GetOpt.java 23 Jan 2005 00:37:17 -0000 1.6
@@ -133,7 +133,6 @@
* If the next option found has been declared to take an argument,
* and no such argument exists, then a MissingOptArgException
* is thrown (case 2).
- * @param none
* @return int - the next option found.
* @throws IllegalArgumentException, MissingOptArgException.
*/
@@ -165,7 +164,6 @@
* gets the argument for the current parsed option. For example,
* in case of '-d <file>', if current option parsed is 'd' then
* getOptionArg() would return '<file>'.
- * @param none
* @return String - argument for current parsed option.
*/
public String getOptionArg(){
@@ -183,7 +181,6 @@
* such as 'cmd -s -d file file2 file3 file4' with the usage
* 'cmd [-s] [-d <file>] <file>...', getCmdArgs() would return
* the list {file2, file3, file4}.
- * @params none
* @return String[] - list of command arguments that may appear
* after options and option arguments.
*/
1.67 +11 -11 xml-xalan/java/src/org/apache/xalan/xsltc/compiler/Parser.java
Index: Parser.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/xsltc/compiler/Parser.java,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -r1.66 -r1.67
--- Parser.java 10 Dec 2004 18:46:42 -0000 1.66
+++ Parser.java 23 Jan 2005 00:37:17 -0000 1.67
@@ -1019,8 +1019,8 @@
/**
* Parse an XPath expression:
- * @parent - XSL element where the expression occured
- * @exp - textual representation of the expression
+ * @param parent - XSL element where the expression occured
+ * @param exp - textual representation of the expression
*/
public Expression parseExpression(SyntaxTreeNode parent, String exp) {
return (Expression)parseTopLevel(parent, "<EXPRESSION>"+exp, null);
@@ -1028,9 +1028,9 @@
/**
* Parse an XPath expression:
- * @parent - XSL element where the expression occured
- * @attr - name of this element's attribute to get expression from
- * @def - default expression (if the attribute was not found)
+ * @param parent - XSL element where the expression occured
+ * @param attr - name of this element's attribute to get expression from
+ * @param def - default expression (if the attribute was not found)
*/
public Expression parseExpression(SyntaxTreeNode parent,
String attr, String def) {
@@ -1044,8 +1044,8 @@
/**
* Parse an XPath pattern:
- * @parent - XSL element where the pattern occured
- * @exp - textual representation of the pattern
+ * @param parent - XSL element where the pattern occured
+ * @param pattern - textual representation of the pattern
*/
public Pattern parsePattern(SyntaxTreeNode parent, String pattern) {
return (Pattern)parseTopLevel(parent, "<PATTERN>"+pattern, pattern);
@@ -1053,9 +1053,9 @@
/**
* Parse an XPath pattern:
- * @parent - XSL element where the pattern occured
- * @attr - name of this element's attribute to get pattern from
- * @def - default pattern (if the attribute was not found)
+ * @param parent - XSL element where the pattern occured
+ * @param attr - name of this element's attribute to get pattern from
+ * @param def - default pattern (if the attribute was not found)
*/
public Pattern parsePattern(SyntaxTreeNode parent,
String attr, String def) {
1.5 +2 -2 xml-xalan/java/src/org/apache/xalan/xsltc/compiler/Pattern.java
Index: Pattern.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/xsltc/compiler/Pattern.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Pattern.java 16 Feb 2004 22:24:29 -0000 1.4
+++ Pattern.java 23 Jan 2005 00:37:17 -0000 1.5
@@ -44,7 +44,7 @@
* make sure to backpatch both true and false lists. True lists are the
* default, in the sense that they always <em>"fall through"</em>. If this
* is not the intended semantics (e.g., see
- * {@link org.apache.xalan.xsltc.compiler.AlternativePattern#translate()})
+ * {@link org.apache.xalan.xsltc.compiler.AlternativePattern#translate})
* then a GOTO must be appended to the instruction list after calling
* <code>translate</code>.
*/
1.6 +3 -3 xml-xalan/java/src/org/apache/xalan/xsltc/dom/DOMWSFilter.java
Index: DOMWSFilter.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/xsltc/dom/DOMWSFilter.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DOMWSFilter.java 16 Feb 2004 22:54:59 -0000 1.5
+++ DOMWSFilter.java 23 Jan 2005 00:37:17 -0000 1.6
@@ -29,7 +29,7 @@
/**
* A wrapper class that adapts the
* {@link org.apache.xml.dtm.DTMWSFilter DTMWSFilter} interface to the XSLTC
- * DOM {@link org.apache.xsltc.StripFilter StripFilter} interface.
+ * DOM {@link org.apache.xalan.xsltc.StripFilter StripFilter} interface.
*/
public class DOMWSFilter implements DTMWSFilter {
@@ -51,7 +51,7 @@
* interface.
*
* @see org.apache.xml.dtm.DTMWSFilter
- * @see org.apache.xsltc.StripFilter
+ * @see org.apache.xalan.xsltc.StripFilter
*/
public DOMWSFilter(AbstractTranslet translet) {
m_translet = translet;
1.57 +6 -6 xml-xalan/java/src/org/apache/xalan/xsltc/runtime/AbstractTranslet.java
Index: AbstractTranslet.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/xsltc/runtime/AbstractTranslet.java,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -r1.56 -r1.57
--- AbstractTranslet.java 15 Jul 2004 07:00:18 -0000 1.56
+++ AbstractTranslet.java 23 Jan 2005 00:37:17 -0000 1.57
@@ -426,9 +426,9 @@
/**
* Adds a value to a key/id index
- * @name is the name of the index (the key or ##id)
- * @node is the node id of the node to insert
- * @value is the value that will look up the node in the given index
+ * @param name is the name of the index (the key or ##id)
+ * @param node is the node id of the node to insert
+ * @param value is the value that will look up the node in the given index
*/
public void buildKeyIndex(String name, int node, Object value) {
if (_keyIndexes == null) _keyIndexes = new Hashtable();
@@ -442,8 +442,8 @@
/**
* Create an empty KeyIndex in the DOM case
- * @name is the name of the index (the key or ##id)
- * @node is the DOM
+ * @param name is the name of the index (the key or ##id)
+ * @param dom is the DOM
*/
public void buildKeyIndex(String name, DOM dom) {
if (_keyIndexes == null) _keyIndexes = new Hashtable();
---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-cvs-help@xml.apache.org