sboag 00/12/16 21:21:23
Modified: java/src/org/apache/xpath/operations And.java Bool.java
Div.java Equals.java Gt.java Gte.java Lt.java
Lte.java Minus.java Mod.java Mult.java Neg.java
NotEquals.java Number.java Operation.java Or.java
Plus.java Quo.java String.java UnaryOperation.java
Variable.java
Log:
Javadoc.
Revision Changes Path
1.4 +4 -4 xml-xalan/java/src/org/apache/xpath/operations/And.java
Index: And.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/And.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- And.java 2000/11/13 16:27:49 1.3
+++ And.java 2000/12/17 05:21:14 1.4
@@ -65,8 +65,7 @@
import org.w3c.dom.Node;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class And <needs-comment/>
+ * The 'and' operation expression executer.
*/
public class And extends Operation
{
@@ -75,9 +74,10 @@
* AND two expressions and return the boolean result. Override
* superclass method for optimization purposes.
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The runtime execution context.
*
- * NEEDSDOC ($objectName$) @return
+ * @return [EMAIL PROTECTED] org.apache.xpath.objects.XBoolean.S_TRUE} or
+ * [EMAIL PROTECTED] org.apache.xpath.objects.XBoolean.S_FALSE}.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +4 -5 xml-xalan/java/src/org/apache/xpath/operations/Bool.java
Index: Bool.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Bool.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Bool.java 2000/11/13 16:27:49 1.3
+++ Bool.java 2000/12/17 05:21:14 1.4
@@ -60,19 +60,18 @@
import org.apache.xpath.objects.XBoolean;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Bool <needs-comment/>
+ * The 'boolean()' operation expression executer.
*/
public class Bool extends UnaryOperation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param right
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6 xml-xalan/java/src/org/apache/xpath/operations/Div.java
Index: Div.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Div.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Div.java 2000/11/13 16:27:49 1.3
+++ Div.java 2000/12/17 05:21:15 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XNumber;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Div <needs-comment/>
+ * The 'div' operation expression executer.
*/
public class Div extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6
xml-xalan/java/src/org/apache/xpath/operations/Equals.java
Index: Equals.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Equals.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Equals.java 2000/11/13 16:27:49 1.3
+++ Equals.java 2000/12/17 05:21:15 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XBoolean;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Equals <needs-comment/>
+ * The '=' operation expression executer.
*/
public class Equals extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6 xml-xalan/java/src/org/apache/xpath/operations/Gt.java
Index: Gt.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Gt.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Gt.java 2000/11/13 16:27:49 1.3
+++ Gt.java 2000/12/17 05:21:15 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XBoolean;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Gt <needs-comment/>
+ * The '>' operation expression executer.
*/
public class Gt extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6 xml-xalan/java/src/org/apache/xpath/operations/Gte.java
Index: Gte.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Gte.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Gte.java 2000/11/13 16:27:49 1.3
+++ Gte.java 2000/12/17 05:21:15 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XBoolean;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Gte <needs-comment/>
+ * The '>=' operation expression executer.
*/
public class Gte extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6 xml-xalan/java/src/org/apache/xpath/operations/Lt.java
Index: Lt.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Lt.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Lt.java 2000/11/13 16:27:49 1.3
+++ Lt.java 2000/12/17 05:21:15 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XBoolean;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Lt <needs-comment/>
+ * The '<' operation expression executer.
*/
public class Lt extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6 xml-xalan/java/src/org/apache/xpath/operations/Lte.java
Index: Lte.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Lte.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Lte.java 2000/11/13 16:27:49 1.3
+++ Lte.java 2000/12/17 05:21:16 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XBoolean;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Lte <needs-comment/>
+ * The '<=' operation expression executer.
*/
public class Lte extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +6 -6 xml-xalan/java/src/org/apache/xpath/operations/Minus.java
Index: Minus.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Minus.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Minus.java 2000/11/13 16:27:49 1.3
+++ Minus.java 2000/12/17 05:21:16 1.4
@@ -60,20 +60,20 @@
import org.apache.xpath.objects.XNumber;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Minus <needs-comment/>
+ * The binary '-' operation expression executer.
*/
public class Minus extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the
+ * result of the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6 xml-xalan/java/src/org/apache/xpath/operations/Mod.java
Index: Mod.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Mod.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Mod.java 2000/11/13 16:27:49 1.3
+++ Mod.java 2000/12/17 05:21:16 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XNumber;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Mod <needs-comment/>
+ * The 'mod' operation expression executer.
*/
public class Mod extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6 xml-xalan/java/src/org/apache/xpath/operations/Mult.java
Index: Mult.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Mult.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Mult.java 2000/11/13 16:27:49 1.3
+++ Mult.java 2000/12/17 05:21:16 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XNumber;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Mult <needs-comment/>
+ * The '*' operation expression executer.
*/
public class Mult extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +4 -5 xml-xalan/java/src/org/apache/xpath/operations/Neg.java
Index: Neg.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Neg.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Neg.java 2000/11/13 16:27:49 1.3
+++ Neg.java 2000/12/17 05:21:16 1.4
@@ -60,19 +60,18 @@
import org.apache.xpath.objects.XNumber;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Neg <needs-comment/>
+ * The unary '-' operation expression executer.
*/
public class Neg extends UnaryOperation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param right
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6
xml-xalan/java/src/org/apache/xpath/operations/NotEquals.java
Index: NotEquals.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xpath/operations/NotEquals.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- NotEquals.java 2000/11/13 16:27:49 1.3
+++ NotEquals.java 2000/12/17 05:21:16 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XBoolean;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class NotEquals <needs-comment/>
+ * The '!=' operation expression executer.
*/
public class NotEquals extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +4 -5
xml-xalan/java/src/org/apache/xpath/operations/Number.java
Index: Number.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Number.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Number.java 2000/11/13 16:27:49 1.3
+++ Number.java 2000/12/17 05:21:17 1.4
@@ -60,19 +60,18 @@
import org.apache.xpath.objects.XNumber;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Number <needs-comment/>
+ * The 'number()' operation expression executer.
*/
public class Number extends UnaryOperation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param right
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +14 -14
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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Operation.java 2000/11/13 16:27:49 1.3
+++ Operation.java 2000/12/17 05:21:17 1.4
@@ -64,24 +64,23 @@
import org.w3c.dom.Node;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Operation <needs-comment/>
+ * The baseclass for a binary operation.
*/
public class Operation extends Expression
{
- /** NEEDSDOC Field m_left */
+ /** The left operand expression. */
protected Expression m_left;
- /** NEEDSDOC Field m_right */
+ /** The right operand expression. */
protected Expression m_right;
/**
- * NEEDSDOC Method setLeftRight
+ * Set the left and right operand expressions for this operation.
*
*
- * NEEDSDOC @param l
- * NEEDSDOC @param r
+ * @param l The left expression operand.
+ * @param r The right expression operand.
*/
public void setLeftRight(Expression l, Expression r)
{
@@ -90,12 +89,13 @@
}
/**
- * NEEDSDOC Method execute
+ * Execute a binary operation by calling execute on each of the operands,
+ * and then calling the operate method on the derived class.
*
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The runtime execution context.
*
- * NEEDSDOC (execute) @return
+ * @return The XObject result of the operation.
*
* @throws javax.xml.transform.TransformerException
*/
@@ -109,13 +109,13 @@
}
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +4 -4 xml-xalan/java/src/org/apache/xpath/operations/Or.java
Index: Or.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Or.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Or.java 2000/11/13 16:27:49 1.3
+++ Or.java 2000/12/17 05:21:17 1.4
@@ -65,8 +65,7 @@
import org.w3c.dom.Node;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Or <needs-comment/>
+ * The 'or' operation expression executer.
*/
public class Or extends Operation
{
@@ -75,9 +74,10 @@
* OR two expressions and return the boolean result. Override
* superclass method for optimization purposes.
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The runtime execution context.
*
- * NEEDSDOC ($objectName$) @return
+ * @return [EMAIL PROTECTED] org.apache.xpath.objects.XBoolean.S_TRUE} or
+ * [EMAIL PROTECTED] org.apache.xpath.objects.XBoolean.S_FALSE}.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -6 xml-xalan/java/src/org/apache/xpath/operations/Plus.java
Index: Plus.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/operations/Plus.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Plus.java 2000/11/13 16:27:49 1.3
+++ Plus.java 2000/12/17 05:21:17 1.4
@@ -60,20 +60,19 @@
import org.apache.xpath.objects.XNumber;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Plus <needs-comment/>
+ * The '+' operation expression executer.
*/
public class Plus extends Operation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +6 -6 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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Quo.java 2000/11/13 16:27:49 1.3
+++ Quo.java 2000/12/17 05:21:17 1.4
@@ -60,8 +60,8 @@
import org.apache.xpath.objects.XNumber;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Quo <needs-comment/>
+ * The 'quo' operation expression executer. (no longer supported by XPath).
+ * @deprecated.
*/
public class Quo extends Operation
{
@@ -69,13 +69,13 @@
// Actually, this is no longer supported by xpath...
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param left
- * NEEDSDOC @param right
+ * @param left non-null reference to the evaluated left operand.
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +4 -5
xml-xalan/java/src/org/apache/xpath/operations/String.java
Index: String.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xpath/operations/String.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- String.java 2000/11/13 16:27:49 1.3
+++ String.java 2000/12/17 05:21:17 1.4
@@ -60,19 +60,18 @@
import org.apache.xpath.objects.XString;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class String <needs-comment/>
+ * The 'string()' operation expression executer.
*/
public class String extends UnaryOperation
{
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param right
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +12 -11
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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- UnaryOperation.java 2000/11/13 16:27:49 1.3
+++ UnaryOperation.java 2000/12/17 05:21:18 1.4
@@ -64,20 +64,20 @@
import org.w3c.dom.Node;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class UnaryOperation <needs-comment/>
+ * The unary operation base class.
*/
public abstract class UnaryOperation extends Expression
{
- /** NEEDSDOC Field m_right */
+ /** The operand for the operation. */
protected Expression m_right;
/**
- * NEEDSDOC Method setRight
+ * Set the expression operand for the operation.
*
*
- * NEEDSDOC @param r
+ * @param r The expression operand to which the unary operation will be
+ * applied.
*/
public void setRight(Expression r)
{
@@ -85,12 +85,13 @@
}
/**
- * NEEDSDOC Method execute
+ * Execute the operand and apply the unary operation to the result.
*
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The runtime execution context.
*
- * NEEDSDOC (execute) @return
+ * @return An XObject that represents the result of applying the unary
+ * operation to the evaluated operand.
*
* @throws javax.xml.transform.TransformerException
*/
@@ -103,12 +104,12 @@
}
/**
- * NEEDSDOC Method operate
+ * Apply the operation to two operands, and return the result.
*
*
- * NEEDSDOC @param right
+ * @param right non-null reference to the evaluated right operand.
*
- * NEEDSDOC (operate) @return
+ * @return non-null reference to the XObject that represents the result of
the operation.
*
* @throws javax.xml.transform.TransformerException
*/
1.7 +9 -9
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.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Variable.java 2000/11/23 04:59:21 1.6
+++ Variable.java 2000/12/17 05:21:18 1.7
@@ -68,20 +68,18 @@
import org.apache.xpath.res.XPATHErrorResources;
/**
- * <meta name="usage" content="internal"/>
- * NEEDSDOC Class Variable <needs-comment/>
+ * The variable reference expression executer.
*/
public class Variable extends Expression
{
- /** NEEDSDOC Field m_qname */
+ /** The qualified name of the variable. */
protected QName m_qname;
/**
- * NEEDSDOC Method setQName
+ * Set the qualified name of the variable.
*
- *
- * NEEDSDOC @param qname
+ * @param qname Must be a non-null reference to a qualified name.
*/
public void setQName(QName qname)
{
@@ -89,12 +87,14 @@
}
/**
- * NEEDSDOC Method execute
+ * Dereference the variable, and return the reference value. Note that
lazy
+ * evaluation will occur. If a variable within scope is not found, a
warning
+ * will be sent to the error listener, and an empty nodeset will be
returned.
*
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The runtime execution context.
*
- * NEEDSDOC (execute) @return
+ * @return The evaluated variable, or an empty nodeset if not found.
*
* @throws javax.xml.transform.TransformerException
*/
