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 02:08:22 UTC
cvs commit: xml-xalan/java/src/org/apache/xpath/res XPATHMessages.java
mcnamara 2005/01/22 17:08:22
Modified: java/src/org/apache/xpath/compiler Compiler.java
OpMapVector.java
java/src/org/apache/xpath/functions Function.java
Function2Args.java Function3Args.java
FunctionMultiArgs.java FunctionOneArg.java
java/src/org/apache/xpath/objects XMLStringFactoryImpl.java
XNumber.java XObject.java XString.java
XStringForFSB.java
java/src/org/apache/xpath/operations Operation.java Quo.java
UnaryOperation.java Variable.java
java/src/org/apache/xpath/patterns FunctionPattern.java
NodeTest.java StepPattern.java UnionPattern.java
java/src/org/apache/xpath/res XPATHMessages.java
Log:
Clean up javadoc to reduce warnings during doc builds. See XALANJ-2048
Revision Changes Path
1.39 +1 -5 xml-xalan/java/src/org/apache/xpath/compiler/Compiler.java
Index: Compiler.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/compiler/Compiler.java,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -r1.38 -r1.39
--- Compiler.java 15 Dec 2004 17:35:55 -0000 1.38
+++ Compiler.java 23 Jan 2005 01:08:21 -0000 1.39
@@ -102,11 +102,7 @@
/**
* Execute the XPath object from a given opcode position.
- * @param xctxt The execution context.
- * @param context The current source tree context node.
* @param opPos The current position in the xpath.m_opMap array.
- * @param callback Interface that implements the processLocatedNode method.
- * @param callbackInfo Object that will be passed to the processLocatedNode method.
* @return The result of the XPath.
*
* @throws TransformerException if there is a syntax or other error.
1.7 +1 -1 xml-xalan/java/src/org/apache/xpath/compiler/OpMapVector.java
Index: OpMapVector.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/compiler/OpMapVector.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- OpMapVector.java 17 Feb 2004 04:32:49 -0000 1.6
+++ OpMapVector.java 23 Jan 2005 01:08:21 -0000 1.7
@@ -73,7 +73,7 @@
* The index must be a value greater than or equal to 0 and less
* than the current size of the vector.
*
- * @param node object to set
+ * @param value object to set
* @param index Index of where to set the object
*/
public final void setElementAt(int value, int index)
1.15 +2 -2 xml-xalan/java/src/org/apache/xpath/functions/Function.java
Index: Function.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/functions/Function.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Function.java 17 Aug 2004 19:25:37 -0000 1.14
+++ Function.java 23 Jan 2005 01:08:21 -0000 1.15
@@ -110,7 +110,7 @@
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.15 +2 -2 xml-xalan/java/src/org/apache/xpath/functions/Function2Args.java
Index: Function2Args.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/functions/Function2Args.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Function2Args.java 17 Aug 2004 19:25:37 -0000 1.14
+++ Function2Args.java 23 Jan 2005 01:08:21 -0000 1.15
@@ -148,7 +148,7 @@
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callArgVisitors(XPathVisitor visitor)
{
1.16 +2 -2 xml-xalan/java/src/org/apache/xpath/functions/Function3Args.java
Index: Function3Args.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/functions/Function3Args.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- Function3Args.java 17 Aug 2004 19:25:37 -0000 1.15
+++ Function3Args.java 23 Jan 2005 01:08:21 -0000 1.16
@@ -146,7 +146,7 @@
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callArgVisitors(XPathVisitor visitor)
{
1.16 +2 -2 xml-xalan/java/src/org/apache/xpath/functions/FunctionMultiArgs.java
Index: FunctionMultiArgs.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/functions/FunctionMultiArgs.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- FunctionMultiArgs.java 17 Aug 2004 19:25:37 -0000 1.15
+++ FunctionMultiArgs.java 23 Jan 2005 01:08:21 -0000 1.16
@@ -187,7 +187,7 @@
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callArgVisitors(XPathVisitor visitor)
{
1.15 +2 -2 xml-xalan/java/src/org/apache/xpath/functions/FunctionOneArg.java
Index: FunctionOneArg.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/functions/FunctionOneArg.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- FunctionOneArg.java 17 Aug 2004 19:25:37 -0000 1.14
+++ FunctionOneArg.java 23 Jan 2005 01:08:21 -0000 1.15
@@ -120,7 +120,7 @@
}
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callArgVisitors(XPathVisitor visitor)
{
1.7 +2 -2 xml-xalan/java/src/org/apache/xpath/objects/XMLStringFactoryImpl.java
Index: XMLStringFactoryImpl.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XMLStringFactoryImpl.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- XMLStringFactoryImpl.java 17 Feb 2004 04:34:38 -0000 1.6
+++ XMLStringFactoryImpl.java 23 Jan 2005 01:08:21 -0000 1.7
@@ -60,7 +60,7 @@
* Create a XMLString from a FastStringBuffer.
*
*
- * @param string FastStringBuffer reference, which must be non-null.
+ * @param fsb FastStringBuffer reference, which must be non-null.
* @param start The start position in the array.
* @param length The number of characters to read from the array.
*
1.21 +3 -3 xml-xalan/java/src/org/apache/xpath/objects/XNumber.java
Index: XNumber.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XNumber.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- XNumber.java 17 Aug 2004 19:25:39 -0000 1.20
+++ XNumber.java 23 Jan 2005 01:08:21 -0000 1.21
@@ -50,7 +50,7 @@
/**
* Construct a XNodeSet object.
*
- * @param d Value of the object
+ * @param num Value of the object
*/
public XNumber(Number num)
{
@@ -424,7 +424,7 @@
}
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.27 +2 -2 xml-xalan/java/src/org/apache/xpath/objects/XObject.java
Index: XObject.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XObject.java,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -r1.26 -r1.27
--- XObject.java 17 Aug 2004 19:25:39 -0000 1.26
+++ XObject.java 23 Jan 2005 01:08:21 -0000 1.27
@@ -727,7 +727,7 @@
}
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.18 +4 -7 xml-xalan/java/src/org/apache/xpath/objects/XString.java
Index: XString.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XString.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- XString.java 15 Dec 2004 17:35:55 -0000 1.17
+++ XString.java 23 Jan 2005 01:08:21 -0000 1.18
@@ -345,10 +345,8 @@
* <code>null</code> and is a <code>String</code> object that represents
* the same sequence of characters as this object.
*
- * @param anObject the object to compare this <code>String</code>
+ * @param obj2 the object to compare this <code>String</code>
* against.
- *
- * NEEDSDOC @param obj2
* @return <code>true</code> if the <code>String </code>are equal;
* <code>false</code> otherwise.
* @see java.lang.String#compareTo(java.lang.String)
@@ -394,9 +392,8 @@
/**
* Compares two strings lexicographically.
*
- * @param anotherString the <code>String</code> to be compared.
+ * @param xstr the <code>String</code> to be compared.
*
- * NEEDSDOC @param xstr
* @return the value <code>0</code> if the argument string is equal to
* this string; a value less than <code>0</code> if this string
* is lexicographically less than the string argument; and a
@@ -1094,7 +1091,7 @@
}
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.24 +6 -12 xml-xalan/java/src/org/apache/xpath/objects/XStringForFSB.java
Index: XStringForFSB.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XStringForFSB.java,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- XStringForFSB.java 19 Nov 2004 15:51:27 -0000 1.23
+++ XStringForFSB.java 23 Jan 2005 01:08:21 -0000 1.24
@@ -276,10 +276,9 @@
* <code>null</code> and is a <code>String</code> object that represents
* the same sequence of characters as this object.
*
- * @param anObject the object to compare this <code>String</code>
+ * @param obj2 the object to compare this <code>String</code>
* against.
*
- * NEEDSDOC @param obj2
* @return <code>true</code> if the <code>String </code>are equal;
* <code>false</code> otherwise.
* @see java.lang.String#compareTo(java.lang.String)
@@ -366,9 +365,7 @@
/**
* Tell if two objects are functionally equal.
*
- * @param obj2 Object to compare this to
- *
- * NEEDSDOC @param anotherString
+ * @param anotherString Object to compare this to
*
* @return true if the two objects are equal
*
@@ -408,10 +405,9 @@
* <code>null</code> and is a <code>String</code> object that represents
* the same sequence of characters as this object.
*
- * @param anObject the object to compare this <code>String</code>
+ * @param obj2 the object to compare this <code>String</code>
* against.
*
- * NEEDSDOC @param obj2
* @return <code>true</code> if the <code>String </code>are equal;
* <code>false</code> otherwise.
* @see java.lang.String#compareTo(java.lang.String)
@@ -461,9 +457,8 @@
/**
* Compares two strings lexicographically.
*
- * @param anotherString the <code>String</code> to be compared.
+ * @param xstr the <code>String</code> to be compared.
*
- * NEEDSDOC @param xstr
* @return the value <code>0</code> if the argument string is equal to
* this string; a value less than <code>0</code> if this string
* is lexicographically less than the string argument; and a
@@ -510,9 +505,8 @@
* The java.text package provides <em>collators</em> to allow
* locale-sensitive ordering.
*
- * @param str the <code>String</code> to be compared.
+ * @param xstr the <code>String</code> to be compared.
*
- * NEEDSDOC @param xstr
* @return a negative integer, zero, or a positive integer as the
* the specified String is greater than, equal to, or less
* than this String, ignoring case considerations.
1.14 +2 -2 xml-xalan/java/src/org/apache/xpath/operations/Operation.java
Index: Operation.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Operation.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- Operation.java 17 Aug 2004 19:25:41 -0000 1.13
+++ Operation.java 23 Jan 2005 01:08:22 -0000 1.14
@@ -163,7 +163,7 @@
}
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.9 +2 -2 xml-xalan/java/src/org/apache/xpath/operations/Quo.java
Index: Quo.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Quo.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Quo.java 17 Aug 2004 19:25:41 -0000 1.8
+++ Quo.java 23 Jan 2005 01:08:22 -0000 1.9
@@ -23,7 +23,7 @@
/**
* The 'quo' operation expression executer. (no longer supported by XPath).
- * @deprecated.
+ * @deprecated
*/
public class Quo extends Operation
{
1.14 +2 -2 xml-xalan/java/src/org/apache/xpath/operations/UnaryOperation.java
Index: UnaryOperation.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/UnaryOperation.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- UnaryOperation.java 17 Aug 2004 19:25:41 -0000 1.13
+++ UnaryOperation.java 23 Jan 2005 01:08:22 -0000 1.14
@@ -115,7 +115,7 @@
}
/**
- * @see XPathVisitable#callVisitors(XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.25 +2 -2 xml-xalan/java/src/org/apache/xpath/operations/Variable.java
Index: Variable.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Variable.java,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- Variable.java 6 Oct 2004 20:04:09 -0000 1.24
+++ Variable.java 23 Jan 2005 01:08:22 -0000 1.25
@@ -335,7 +335,7 @@
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.15 +1 -4 xml-xalan/java/src/org/apache/xpath/patterns/FunctionPattern.java
Index: FunctionPattern.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/patterns/FunctionPattern.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- FunctionPattern.java 17 Aug 2004 19:25:42 -0000 1.14
+++ FunctionPattern.java 23 Jan 2005 01:08:22 -0000 1.15
@@ -39,9 +39,6 @@
* Construct a FunctionPattern from a
* {@link org.apache.xpath.functions.Function expression}.
*
- *
- * @param a should be a {@link org.apache.xpath.functions.Function expression}.
- *
* NEEDSDOC @param expr
*/
public FunctionPattern(Expression expr, int axis, int predaxis)
1.30 +2 -2 xml-xalan/java/src/org/apache/xpath/patterns/NodeTest.java
Index: NodeTest.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/patterns/NodeTest.java,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- NodeTest.java 1 Oct 2004 22:01:24 -0000 1.29
+++ NodeTest.java 23 Jan 2005 01:08:22 -0000 1.30
@@ -680,7 +680,7 @@
}
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.31 +2 -2 xml-xalan/java/src/org/apache/xpath/patterns/StepPattern.java
Index: StepPattern.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/patterns/StepPattern.java,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- StepPattern.java 15 Dec 2004 17:35:56 -0000 1.30
+++ StepPattern.java 23 Jan 2005 01:08:22 -0000 1.31
@@ -960,7 +960,7 @@
}
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.15 +2 -2 xml-xalan/java/src/org/apache/xpath/patterns/UnionPattern.java
Index: UnionPattern.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/patterns/UnionPattern.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- UnionPattern.java 17 Aug 2004 19:25:42 -0000 1.14
+++ UnionPattern.java 23 Jan 2005 01:08:22 -0000 1.15
@@ -168,7 +168,7 @@
}
/**
- * @see XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
+ * @see org.apache.xpath.XPathVisitable#callVisitors(ExpressionOwner, XPathVisitor)
*/
public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
{
1.6 +2 -4 xml-xalan/java/src/org/apache/xpath/res/XPATHMessages.java
Index: XPATHMessages.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/res/XPATHMessages.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- XPATHMessages.java 17 Feb 2004 04:36:46 -0000 1.5
+++ XPATHMessages.java 23 Jan 2005 01:08:22 -0000 1.6
@@ -39,7 +39,7 @@
* Creates a message from the specified key and replacement
* arguments, localized to the given locale.
*
- * @param errorCode The key for the message text.
+ * @param msgKey The key for the message text.
* @param args The arguments to be used as replacement text
* in the message created.
*
@@ -84,8 +84,6 @@
/**
* Creates a message from the specified key and replacement
* arguments, localized to the given locale.
- *
- * @param errorCode The key for the message text.
*
* @param fResourceBundle The resource bundle to use.
* @param msgKey The message key to use.
---------------------------------------------------------------------
To unsubscribe, e-mail: xalan-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-cvs-help@xml.apache.org