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/14 22:18:15 UTC
cvs commit: xml-xalan/java/src/org/apache/xpath/objects XBoolean.java XBooleanStatic.java XNodeSet.java XNull.java XNumber.java XObject.java XRTreeFrag.java XString.java
mmidy 00/12/14 13:18:13
Modified: java/src/org/apache/xpath/objects XBoolean.java
XBooleanStatic.java XNodeSet.java XNull.java
XNumber.java XObject.java XRTreeFrag.java
XString.java
Log:
Javadoc updates
Revision Changes Path
1.6 +12 -12 xml-xalan/java/src/org/apache/xpath/objects/XBoolean.java
Index: XBoolean.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XBoolean.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- XBoolean.java 2000/11/13 16:27:45 1.5
+++ XBoolean.java 2000/12/14 21:18:01 1.6
@@ -78,13 +78,13 @@
*/
public static XBoolean S_FALSE = new XBooleanStatic(false);
- /** NEEDSDOC Field m_val */
+ /** Value of the object */
boolean m_val;
/**
- * Construct a XNodeSet object.
+ * Construct a XBoolean object.
*
- * NEEDSDOC @param b
+ * @param b Value of the boolean object
*/
public XBoolean(boolean b)
{
@@ -97,7 +97,7 @@
/**
* Tell that this is a CLASS_BOOLEAN.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type of CLASS_BOOLEAN
*/
public int getType()
{
@@ -108,7 +108,7 @@
* Given a request type, return the equivalent string.
* For diagnostic purposes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type string "#BOOLEAN"
*/
public String getTypeString()
{
@@ -118,7 +118,7 @@
/**
* Cast result object to a number.
*
- * NEEDSDOC ($objectName$) @return
+ * @return numeric value of the object value
*/
public double num()
{
@@ -128,7 +128,7 @@
/**
* Cast result object to a boolean.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The object value as a boolean
*/
public boolean bool()
{
@@ -138,7 +138,7 @@
/**
* Cast result object to a string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The object's value as a string
*/
public String str()
{
@@ -146,10 +146,10 @@
}
/**
- * Return a java object that's closes to the represenation
+ * Return a java object that's closest to the representation
* that should be handed to an extension.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The object's value as a java object
*/
public Object object()
{
@@ -159,9 +159,9 @@
/**
* Tell if two objects are functionally equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare to this
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the two objects are equal
*
* @throws javax.xml.transform.TransformerException
*/
1.4 +5 -5 xml-xalan/java/src/org/apache/xpath/objects/XBooleanStatic.java
Index: XBooleanStatic.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XBooleanStatic.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- XBooleanStatic.java 2000/11/13 16:27:45 1.3
+++ XBooleanStatic.java 2000/12/14 21:18:02 1.4
@@ -69,13 +69,13 @@
public class XBooleanStatic extends XBoolean
{
- /** NEEDSDOC Field m_val */
+ /** The value of the object */
boolean m_val;
/**
- * Construct a XNodeSet object.
+ * Construct a XBooleanStatic object.
*
- * NEEDSDOC @param b
+ * @param b The value of the object
*/
public XBooleanStatic(boolean b)
{
@@ -88,9 +88,9 @@
/**
* Tell if two objects are functionally equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare to this
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the two objects are equal
*
* @throws javax.xml.transform.TransformerException
*/
1.10 +96 -94 xml-xalan/java/src/org/apache/xpath/objects/XNodeSet.java
Index: XNodeSet.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XNodeSet.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- XNodeSet.java 2000/11/23 04:59:17 1.9
+++ XNodeSet.java 2000/12/14 21:18:02 1.10
@@ -78,7 +78,7 @@
/**
* Construct a XNodeSet object.
*
- * NEEDSDOC @param val
+ * @param val Value of the XNodeSet object
*/
public XNodeSet(NodeIterator val)
{
@@ -96,7 +96,7 @@
/**
* Construct a XNodeSet object for one node.
*
- * NEEDSDOC @param n
+ * @param n Node to add to the new XNodeSet object
*/
public XNodeSet(Node n)
{
@@ -112,7 +112,7 @@
/**
* Tell that this is a CLASS_NODESET.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type CLASS_NODESET
*/
public int getType()
{
@@ -123,7 +123,7 @@
* Given a request type, return the equivalent string.
* For diagnostic purposes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type string "#NODESET"
*/
public String getTypeString()
{
@@ -131,11 +131,11 @@
}
/**
- * Get the string conversion from a single node.
+ * Get numeric value of the string conversion from a single node.
*
- * NEEDSDOC @param n
+ * @param n Node to convert
*
- * NEEDSDOC ($objectName$) @return
+ * @return numeric value of the string conversion from a single node.
*/
public static double getNumberFromNode(Node n)
{
@@ -145,7 +145,8 @@
/**
* Cast result object to a number.
*
- * NEEDSDOC ($objectName$) @return
+ * @return numeric value of the string conversion from the
+ * next node in the NodeSet, or NAN if no node was found
*/
public double num()
{
@@ -159,7 +160,7 @@
/**
* Cast result object to a boolean.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if there is a next node in the nodeset
*/
public boolean bool()
{
@@ -169,9 +170,9 @@
/**
* Get the string conversion from a single node.
*
- * NEEDSDOC @param n
+ * @param n Node to convert
*
- * NEEDSDOC ($objectName$) @return
+ * @return the string conversion from a single node.
*/
public static String getStringFromNode(Node n)
{
@@ -196,7 +197,8 @@
/**
* Cast result object to a string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the string conversion from the next node in the nodeset
+ * or "" if there is no next node
*/
public String str()
{
@@ -210,9 +212,9 @@
/**
* Cast result object to a result tree fragment.
*
- * NEEDSDOC @param support
+ * @param support The XPath context to use for the conversion
*
- * NEEDSDOC ($objectName$) @return
+ * @return the nodeset as a result tree fragment.
*/
public DocumentFragment rtree(XPathContext support)
{
@@ -233,7 +235,7 @@
/**
* Cast result object to a nodelist.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The nodeset as a nodelist
*/
public NodeIterator nodeset()
{
@@ -271,9 +273,9 @@
}
/**
- * Cast result object to a nodelist.
+ * Cast result object to a mutableNodeset.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The nodeset as a mutableNodeset
*/
public NodeSet mutableNodeset()
{
@@ -293,32 +295,32 @@
return mnl;
}
- /** NEEDSDOC Field S_LT */
+ /** Less than comparator */
static LessThanComparator S_LT = new LessThanComparator();
- /** NEEDSDOC Field S_LTE */
+ /** Less than or equal comparator */
static LessThanOrEqualComparator S_LTE = new LessThanOrEqualComparator();
- /** NEEDSDOC Field S_GT */
+ /** Greater than comparator */
static GreaterThanComparator S_GT = new GreaterThanComparator();
- /** NEEDSDOC Field S_GTE */
+ /** Greater than or equal comparator */
static GreaterThanOrEqualComparator S_GTE =
new GreaterThanOrEqualComparator();
- /** NEEDSDOC Field S_EQ */
+ /** Equal comparator */
static EqualComparator S_EQ = new EqualComparator();
- /** NEEDSDOC Field S_NEQ */
+ /** Not equal comparator */
static NotEqualComparator S_NEQ = new NotEqualComparator();
/**
* Tell if one object is less than the other.
*
- * NEEDSDOC @param obj2
- * NEEDSDOC @param comparator
+ * @param obj2 Object to compare this nodeset to
+ * @param comparator Comparator to use
*
- * NEEDSDOC ($objectName$) @return
+ * @return See the comments below for each object type comparison
*
* @throws javax.xml.transform.TransformerException
*/
@@ -509,9 +511,9 @@
/**
* Tell if one object is less than the other.
*
- * NEEDSDOC @param obj2
+ * @param obj2 object to compare this nodeset to
*
- * NEEDSDOC ($objectName$) @return
+ * @return see this.compare(...)
*
* @throws javax.xml.transform.TransformerException
*/
@@ -523,9 +525,9 @@
/**
* Tell if one object is less than or equal to the other.
*
- * NEEDSDOC @param obj2
+ * @param obj2 object to compare this nodeset to
*
- * NEEDSDOC ($objectName$) @return
+ * @return see this.compare(...)
*
* @throws javax.xml.transform.TransformerException
*/
@@ -537,9 +539,9 @@
/**
* Tell if one object is less than the other.
*
- * NEEDSDOC @param obj2
+ * @param obj2 object to compare this nodeset to
*
- * NEEDSDOC ($objectName$) @return
+ * @return see this.compare(...)
*
* @throws javax.xml.transform.TransformerException
*/
@@ -551,9 +553,9 @@
/**
* Tell if one object is less than the other.
*
- * NEEDSDOC @param obj2
+ * @param obj2 object to compare this nodeset to
*
- * NEEDSDOC ($objectName$) @return
+ * @return see this.compare(...)
*
* @throws javax.xml.transform.TransformerException
*/
@@ -566,9 +568,9 @@
/**
* Tell if two objects are functionally equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 object to compare this nodeset to
*
- * NEEDSDOC ($objectName$) @return
+ * @return see this.compare(...)
*
* @throws javax.xml.transform.TransformerException
*/
@@ -580,9 +582,9 @@
/**
* Tell if two objects are functionally not equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 object to compare this nodeset to
*
- * NEEDSDOC ($objectName$) @return
+ * @return see this.compare(...)
*
* @throws javax.xml.transform.TransformerException
*/
@@ -599,24 +601,24 @@
{
/**
- * NEEDSDOC Method compareStrings
+ * Compare two strings
*
*
- * NEEDSDOC @param s1
- * NEEDSDOC @param s2
+ * @param s1 First string to compare
+ * @param s2 Second String to compare
*
- * NEEDSDOC (compareStrings) @return
+ * @return Whether the strings are equal or not
*/
abstract boolean compareStrings(String s1, String s2);
/**
- * NEEDSDOC Method compareNumbers
+ * Compare two numbers
*
*
- * NEEDSDOC @param n1
- * NEEDSDOC @param n2
+ * @param n1 First number to compare
+ * @param n2 Second number to compare
*
- * NEEDSDOC (compareNumbers) @return
+ * @return Whether the numbers are equal or not
*/
abstract boolean compareNumbers(double n1, double n2);
}
@@ -628,13 +630,13 @@
{
/**
- * NEEDSDOC Method compareStrings
+ * Compare two strings for less than.
*
*
- * NEEDSDOC @param s1
- * NEEDSDOC @param s2
+ * @param s1 First string to compare
+ * @param s2 Second String to compare
*
- * NEEDSDOC (compareStrings) @return
+ * @return True if s1 is less than s2
*/
boolean compareStrings(String s1, String s2)
{
@@ -642,13 +644,13 @@
}
/**
- * NEEDSDOC Method compareNumbers
+ * Compare two numbers for less than.
*
*
- * NEEDSDOC @param n1
- * NEEDSDOC @param n2
+ * @param n1 First number to compare
+ * @param n2 Second number to compare
*
- * NEEDSDOC (compareNumbers) @return
+ * @return true if n1 is less than n2
*/
boolean compareNumbers(double n1, double n2)
{
@@ -663,13 +665,13 @@
{
/**
- * NEEDSDOC Method compareStrings
+ * Compare two strings for less than or equal.
*
*
- * NEEDSDOC @param s1
- * NEEDSDOC @param s2
+ * @param s1 First string to compare
+ * @param s2 Second String to compare
*
- * NEEDSDOC (compareStrings) @return
+ * @return true if s1 is less than or equal to s2
*/
boolean compareStrings(String s1, String s2)
{
@@ -677,13 +679,13 @@
}
/**
- * NEEDSDOC Method compareNumbers
+ * Compare two numbers for less than or equal.
*
*
- * NEEDSDOC @param n1
- * NEEDSDOC @param n2
+ * @param n1 First number to compare
+ * @param n2 Second number to compare
*
- * NEEDSDOC (compareNumbers) @return
+ * @return true if n1 is less than or equal to n2
*/
boolean compareNumbers(double n1, double n2)
{
@@ -698,13 +700,13 @@
{
/**
- * NEEDSDOC Method compareStrings
+ * Compare two strings for greater than.
*
*
- * NEEDSDOC @param s1
- * NEEDSDOC @param s2
+ * @param s1 First string to compare
+ * @param s2 Second String to compare
*
- * NEEDSDOC (compareStrings) @return
+ * @return true if s1 is greater than s2
*/
boolean compareStrings(String s1, String s2)
{
@@ -712,13 +714,13 @@
}
/**
- * NEEDSDOC Method compareNumbers
+ * Compare two numbers for greater than.
*
*
- * NEEDSDOC @param n1
- * NEEDSDOC @param n2
+ * @param n1 First number to compare
+ * @param n2 Second number to compare
*
- * NEEDSDOC (compareNumbers) @return
+ * @return true if n1 is greater than n2
*/
boolean compareNumbers(double n1, double n2)
{
@@ -733,13 +735,13 @@
{
/**
- * NEEDSDOC Method compareStrings
+ * Compare two strings for greater than or equal.
*
*
- * NEEDSDOC @param s1
- * NEEDSDOC @param s2
+ * @param s1 First string to compare
+ * @param s2 Second String to compare
*
- * NEEDSDOC (compareStrings) @return
+ * @return true if s1 is greater than or equal to s2
*/
boolean compareStrings(String s1, String s2)
{
@@ -747,13 +749,13 @@
}
/**
- * NEEDSDOC Method compareNumbers
+ * Compare two numbers for greater than or equal.
*
*
- * NEEDSDOC @param n1
- * NEEDSDOC @param n2
+ * @param n1 First number to compare
+ * @param n2 Second number to compare
*
- * NEEDSDOC (compareNumbers) @return
+ * @return true if n1 is greater than or equal to n2
*/
boolean compareNumbers(double n1, double n2)
{
@@ -768,13 +770,13 @@
{
/**
- * NEEDSDOC Method compareStrings
+ * Compare two strings for equality.
*
*
- * NEEDSDOC @param s1
- * NEEDSDOC @param s2
+ * @param s1 First string to compare
+ * @param s2 Second String to compare
*
- * NEEDSDOC (compareStrings) @return
+ * @return true if s1 is equal to s2
*/
boolean compareStrings(String s1, String s2)
{
@@ -782,13 +784,13 @@
}
/**
- * NEEDSDOC Method compareNumbers
+ * Compare two numbers for equality.
*
*
- * NEEDSDOC @param n1
- * NEEDSDOC @param n2
+ * @param n1 First number to compare
+ * @param n2 Second number to compare
*
- * NEEDSDOC (compareNumbers) @return
+ * @return true if n1 is equal to n2
*/
boolean compareNumbers(double n1, double n2)
{
@@ -803,13 +805,13 @@
{
/**
- * NEEDSDOC Method compareStrings
+ * Compare two strings for non-equality.
*
*
- * NEEDSDOC @param s1
- * NEEDSDOC @param s2
+ * @param s1 First string to compare
+ * @param s2 Second String to compare
*
- * NEEDSDOC (compareStrings) @return
+ * @return true if s1 is not equal to s2
*/
boolean compareStrings(String s1, String s2)
{
@@ -817,13 +819,13 @@
}
/**
- * NEEDSDOC Method compareNumbers
+ * Compare two numbers for non-equality.
*
*
- * NEEDSDOC @param n1
- * NEEDSDOC @param n2
+ * @param n1 First number to compare
+ * @param n2 Second number to compare
*
- * NEEDSDOC (compareNumbers) @return
+ * @return true if n1 is not equal to n2
*/
boolean compareNumbers(double n1, double n2)
{
1.5 +11 -9 xml-xalan/java/src/org/apache/xpath/objects/XNull.java
Index: XNull.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XNull.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- XNull.java 2000/10/30 19:00:24 1.4
+++ XNull.java 2000/12/14 21:18:03 1.5
@@ -81,7 +81,7 @@
/**
* Tell what kind of class this is.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type CLASS_NULL
*/
public int getType()
{
@@ -92,7 +92,7 @@
* Given a request type, return the equivalent string.
* For diagnostic purposes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type string "#CLASS_NULL"
*/
public String getTypeString()
{
@@ -101,6 +101,8 @@
/**
* Cast result object to a number.
+ *
+ * @return 0.0
*/
public double num()
@@ -111,7 +113,7 @@
/**
* Cast result object to a boolean.
*
- * NEEDSDOC ($objectName$) @return
+ * @return false
*/
public boolean bool()
{
@@ -121,7 +123,7 @@
/**
* Cast result object to a string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return empty string ""
*/
public String str()
{
@@ -131,9 +133,9 @@
/**
* Cast result object to a result tree fragment.
*
- * NEEDSDOC @param support
+ * @param support XPath context to use for the conversion
*
- * NEEDSDOC ($objectName$) @return
+ * @return The object as a result tree fragment.
*/
public DocumentFragment rtree(XPathContext support)
{
@@ -147,7 +149,7 @@
/**
* Cast result object to a nodelist.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public NodeIterator nodeset()
{
@@ -157,9 +159,9 @@
/**
* Tell if two objects are functionally equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the given object is of type CLASS_NULL
*/
public boolean equals(XObject obj2)
{
1.7 +15 -14 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.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- XNumber.java 2000/11/13 16:27:45 1.6
+++ XNumber.java 2000/12/14 21:18:03 1.7
@@ -66,13 +66,13 @@
public class XNumber extends XObject
{
- /** NEEDSDOC Field m_val */
+ /** Value of the XNumber object */
double m_val;
/**
* Construct a XNodeSet object.
*
- * NEEDSDOC @param d
+ * @param d Value of the object
*/
public XNumber(double d)
{
@@ -85,7 +85,7 @@
/**
* Tell that this is a CLASS_NUMBER.
*
- * NEEDSDOC ($objectName$) @return
+ * @return node type CLASS_NUMBER
*/
public int getType()
{
@@ -96,7 +96,7 @@
* Given a request type, return the equivalent string.
* For diagnostic purposes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type string "#NUMBER"
*/
public String getTypeString()
{
@@ -106,7 +106,7 @@
/**
* Cast result object to a number.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the value of the XNumber object
*/
public double num()
{
@@ -116,7 +116,7 @@
/**
* Cast result object to a boolean.
*
- * NEEDSDOC ($objectName$) @return
+ * @return false if the value is NaN or equal to 0.0
*/
public boolean bool()
{
@@ -126,7 +126,8 @@
/**
* Cast result object to a string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return "NaN" if the number is NaN, Infinity or -Infinity if
+ * the number is infinite or the string value of the number.
*/
public String str()
{
@@ -190,12 +191,12 @@
}
/**
- * NEEDSDOC Method zeros
+ * Return a string of '0' of the given length
*
*
- * NEEDSDOC @param n
+ * @param n Length of the string to be returned
*
- * NEEDSDOC (zeros) @return
+ * @return a string of '0' with the given length
*/
static private String zeros(int n)
{
@@ -211,10 +212,10 @@
}
/**
- * Return a java object that's closes to the represenation
+ * Return a java object that's closest to the representation
* that should be handed to an extension.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of this XNumber as a Double object
*/
public Object object()
{
@@ -224,9 +225,9 @@
/**
* Tell if two objects are functionally equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return true if the two objects are equal
*
* @throws javax.xml.transform.TransformerException
*/
1.7 +46 -46 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.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- XObject.java 2000/11/13 16:27:45 1.6
+++ XObject.java 2000/12/14 21:18:03 1.7
@@ -116,9 +116,9 @@
/**
* Create the right XObject based on the type of the object passed.
*
- * NEEDSDOC @param val
+ * @param val The java object which this object will wrap.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the right XObject based on the type of the object passed.
*/
static public XObject create(Object val)
{
@@ -162,25 +162,25 @@
return result;
}
- /** NEEDSDOC Field CLASS_NULL */
+ /** Constant for NULL object type */
public static final int CLASS_NULL = -1;
- /** NEEDSDOC Field CLASS_UNKNOWN */
+ /** Constant for UNKNOWN object type */
public static final int CLASS_UNKNOWN = 0;
- /** NEEDSDOC Field CLASS_BOOLEAN */
+ /** Constant for BOOLEAN object type */
public static final int CLASS_BOOLEAN = 1;
- /** NEEDSDOC Field CLASS_NUMBER */
+ /** Constant for NUMBER object type */
public static final int CLASS_NUMBER = 2;
- /** NEEDSDOC Field CLASS_STRING */
+ /** Constant for STRING object type */
public static final int CLASS_STRING = 3;
- /** NEEDSDOC Field CLASS_NODESET */
+ /** Constant for NODESET object type */
public static final int CLASS_NODESET = 4;
- /** NEEDSDOC Field CLASS_RTREEFRAG */
+ /** Constant for RESULT TREE FRAGMENT object type */
public static final int CLASS_RTREEFRAG = 5;
/** Represents an unresolved variable type as an integer. */
@@ -200,7 +200,7 @@
* Given a request type, return the equivalent string.
* For diagnostic purposes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type string "#UNKNOWN" + object class name
*/
public String getTypeString()
{
@@ -208,9 +208,9 @@
}
/**
- * Cast result object to a number.
+ * Cast result object to a number. Always issues an error.
*
- * NEEDSDOC ($objectName$) @return
+ * @return 0.0
*
* @throws javax.xml.transform.TransformerException
*/
@@ -224,9 +224,9 @@
}
/**
- * Cast result object to a boolean.
+ * Cast result object to a boolean. Always issues an error.
*
- * NEEDSDOC ($objectName$) @return
+ * @return false
*
* @throws javax.xml.transform.TransformerException
*/
@@ -242,7 +242,7 @@
/**
* Cast result object to a string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The object as a string
*/
public String str()
{
@@ -250,10 +250,10 @@
}
/**
- * NEEDSDOC Method toString
+ * Return the string representation of the object
*
*
- * NEEDSDOC (toString) @return
+ * @return the string representation of the object
*/
public String toString()
{
@@ -263,9 +263,9 @@
/**
* Cast result object to a result tree fragment.
*
- * NEEDSDOC @param support
+ * @param support XPath context to use for the conversion
*
- * NEEDSDOC ($objectName$) @return
+ * @return the objec as a result tree fragment.
*/
public DocumentFragment rtree(XPathContext support)
{
@@ -289,7 +289,7 @@
/**
* For functions to override.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public DocumentFragment rtree()
{
@@ -297,10 +297,10 @@
}
/**
- * Return a java object that's closes to the represenation
+ * Return a java object that's closest to the representation
* that should be handed to an extension.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The object that this class wraps
*/
public Object object()
{
@@ -308,9 +308,9 @@
}
/**
- * Cast result object to a nodelist.
+ * Cast result object to a nodelist. Always issues an error.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws javax.xml.transform.TransformerException
*/
@@ -324,9 +324,9 @@
}
/**
- * Cast result object to a nodelist.
+ * Cast result object to a nodelist. Always issues an error.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The object as a NodeSet.
*
* @throws javax.xml.transform.TransformerException
*/
@@ -342,10 +342,10 @@
/**
* Cast object to type t.
*
- * NEEDSDOC @param t
- * NEEDSDOC @param support
+ * @param t Type of object to cast this to
+ * @param support XPath context to use for the conversion
*
- * NEEDSDOC ($objectName$) @return
+ * @return This object as the given type t
*
* @throws javax.xml.transform.TransformerException
*/
@@ -389,9 +389,9 @@
/**
* Tell if one object is less than the other.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if this object is less than the given object
*
* @throws javax.xml.transform.TransformerException
*/
@@ -412,9 +412,9 @@
/**
* Tell if one object is less than or equal to the other.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if this object is less than or equal to the given object
*
* @throws javax.xml.transform.TransformerException
*/
@@ -433,11 +433,11 @@
}
/**
- * Tell if one object is less than the other.
+ * Tell if one object is greater than the other.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if this object is greater than the given object
*
* @throws javax.xml.transform.TransformerException
*/
@@ -456,11 +456,11 @@
}
/**
- * Tell if one object is less than the other.
+ * Tell if one object is greater than or equal to the other.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if this object is greater than or equal to the given object
*
* @throws javax.xml.transform.TransformerException
*/
@@ -482,9 +482,9 @@
/**
* Tell if two objects are functionally equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if this object is equal to the given object
*
* @throws javax.xml.transform.TransformerException
*/
@@ -503,9 +503,9 @@
/**
* Tell if two objects are functionally not equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if this object is not equal to the given object
*
* @throws javax.xml.transform.TransformerException
*/
@@ -525,7 +525,7 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param msg
+ * @param msg Error message to issue
*
* @throws javax.xml.transform.TransformerException
*/
@@ -538,8 +538,8 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param msg Error message to issue
+ * @param args Arguments to use in the message
*
* @throws javax.xml.transform.TransformerException
*/
1.11 +21 -21 xml-xalan/java/src/org/apache/xpath/objects/XRTreeFrag.java
Index: XRTreeFrag.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/objects/XRTreeFrag.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- XRTreeFrag.java 2000/12/07 19:58:28 1.10
+++ XRTreeFrag.java 2000/12/14 21:18:04 1.11
@@ -71,9 +71,9 @@
{
/**
- * Create an XObject.
+ * Create an XRTreeFrag Object.
*
- * NEEDSDOC @param frag
+ * @param frag Document fragment this will wrap
*/
public XRTreeFrag(DocumentFragment frag)
{
@@ -83,7 +83,7 @@
/**
* Tell what kind of class this is.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type CLASS_RTREEFRAG
*/
public int getType()
{
@@ -94,7 +94,7 @@
* Given a request type, return the equivalent string.
* For diagnostic purposes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type string "#RTREEFRAG"
*/
public String getTypeString()
{
@@ -104,7 +104,7 @@
/**
* Cast result object to a number.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The result tree fragment as a number or NaN
*/
public double num()
{
@@ -143,7 +143,7 @@
* Cast result object to a boolean. This always returns true for a RTreeFrag
* because it is treated like a node-set with a single root node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return true
*/
public boolean bool()
{
@@ -153,7 +153,7 @@
/**
* Cast result object to a string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The document fragment node data or the empty string.
*/
public String str()
{
@@ -166,7 +166,7 @@
/**
* Cast result object to a result tree fragment.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The document fragment this wraps
*/
public DocumentFragment rtree()
{
@@ -174,9 +174,9 @@
}
/**
- * Cast result object to a nodelist.
+ * Cast result object to a NodeIterator.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The document fragment as a NodeIterator
*/
public NodeIterator asNodeIterator()
{
@@ -190,7 +190,7 @@
/**
* Cast result object to a nodelist. (special function).
*
- * NEEDSDOC ($objectName$) @return
+ * @return The document fragment as a nodelist
*/
public NodeList convertToNodeset()
{
@@ -204,9 +204,9 @@
/**
* Tell if two objects are functionally equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the two objects are equal
*
* @throws javax.xml.transform.TransformerException
*/
@@ -251,22 +251,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class NodeIteratorWrapper <needs-comment/>
+ * Class to wrap a NodeIterator object
*/
class NodeIteratorWrapper implements NodeIterator
{
- /** NEEDSDOC Field m_pos */
+ /** Position of next node */
private int m_pos = -1;
- /** NEEDSDOC Field m_docFrag */
+ /** Document fragment instance this will wrap */
private DocumentFragment m_docFrag;
/**
* Constructor NodeIteratorWrapper
*
*
- * NEEDSDOC @param df
+ * @param df Document fragment instance this will wrap
*/
NodeIteratorWrapper(DocumentFragment df)
{
@@ -276,7 +276,7 @@
/**
* The root node of the Iterator, as specified when it was created.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getRoot()
{
@@ -288,7 +288,7 @@
* iterator. The available set of constants is defined in the
* <code>NodeFilter</code> interface.
*
- * NEEDSDOC ($objectName$) @return
+ * @return All node types
*/
public int getWhatToShow()
{
@@ -298,7 +298,7 @@
/**
* The filter used to screen nodes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public NodeFilter getFilter()
{
@@ -317,7 +317,7 @@
* expansion, use the whatToShow flags to show the entity reference node
* and set expandEntityReferences to false.
*
- * NEEDSDOC ($objectName$) @return
+ * @return true
*/
public boolean getExpandEntityReferences()
{
1.6 +16 -13 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.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- XString.java 2000/11/13 16:27:45 1.5
+++ XString.java 2000/12/14 21:18:05 1.6
@@ -68,13 +68,13 @@
public class XString extends XObject
{
- /** NEEDSDOC Field EMPTYSTRING */
+ /** Empty string XString object */
public static XString EMPTYSTRING = new XString("");
/**
* Construct a XNodeSet object.
*
- * NEEDSDOC @param val
+ * @param val String object this will wrap.
*/
public XString(String val)
{
@@ -84,7 +84,7 @@
/**
* Tell that this is a CLASS_STRING.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type CLASS_STRING
*/
public int getType()
{
@@ -95,7 +95,7 @@
* Given a request type, return the equivalent string.
* For diagnostic purposes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return type string "#STRING"
*/
public String getTypeString()
{
@@ -105,9 +105,10 @@
/**
* Cast a string to a number.
*
- * NEEDSDOC @param s
+ * @param s The string to convert
*
- * NEEDSDOC ($objectName$) @return
+ * @return 0.0 if the string is null, numeric value of the string
+ * or NaN
*/
public static double castToNum(String s)
{
@@ -163,7 +164,8 @@
/**
* Cast result object to a number.
*
- * NEEDSDOC ($objectName$) @return
+ * @return 0.0 if this string is null, numeric value of this string
+ * or NaN
*/
public double num()
{
@@ -173,7 +175,8 @@
/**
* Cast result object to a boolean.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the length of this string object is greater
+ * than 0.
*/
public boolean bool()
{
@@ -183,7 +186,7 @@
/**
* Cast result object to a string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The string this wraps or the empty string if null
*/
public String str()
{
@@ -193,9 +196,9 @@
/**
* Cast result object to a result tree fragment.
*
- * NEEDSDOC @param support
+ * @param support Xpath context to use for the conversion
*
- * NEEDSDOC ($objectName$) @return
+ * @return A document fragment with this string as a child node
*/
public DocumentFragment rtree(XPathContext support)
{
@@ -213,9 +216,9 @@
/**
* Tell if two objects are functionally equal.
*
- * NEEDSDOC @param obj2
+ * @param obj2 Object to compare this to
*
- * NEEDSDOC ($objectName$) @return
+ * @return true if the two objects are equal
*
* @throws javax.xml.transform.TransformerException
*/