mmidy 00/12/05 14:30:19
Modified: java/src/org/apache/xalan/templates AVT.java AVTPart.java
ElemApplyImport.java ElemApplyTemplates.java
ElemAttribute.java ElemAttributeSet.java
ElemCallTemplate.java ElemChoose.java
ElemComment.java ElemCopy.java ElemCopyOf.java
ElemElement.java ElemExtensionCall.java
ElemExtensionDecl.java ElemExtensionScript.java
ElemFallback.java ElemForEach.java ElemIf.java
ElemMessage.java ElemNumber.java ElemOtherwise.java
ElemPI.java ElemParam.java ElemSort.java
ElemTemplate.java ElemTemplateElement.java
ElemText.java ElemTextLiteral.java ElemUse.java
ElemValueOf.java ElemVariable.java ElemWhen.java
ElemWithParam.java FuncDocument.java
FuncFormatNumb.java FuncKey.java
KeyDeclaration.java OutputFormatExtended.java
Recomposable.java RecomposableBase.java
RecomposableImpl.java StylesheetComposed.java
Log:
Update javadoc
Revision Changes Path
1.11 +4 -4 xml-xalan/java/src/org/apache/xalan/templates/AVT.java
Index: AVT.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/templates/AVT.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- AVT.java 2000/12/01 17:50:10 1.10
+++ AVT.java 2000/12/05 22:29:21 1.11
@@ -435,7 +435,7 @@
/**
* Get the AVT as the original string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The AVT as the original string
*/
public String getSimpleString()
{
@@ -480,12 +480,12 @@
/**
* Evaluate the AVT and return a String.
*
- * NEEDSDOC @param xctxt
+ * @param xctxt Te XPathContext to use to evaluate this.
* @param context The current source tree context.
* @param nsNode The current namespace context (stylesheet tree context).
* @param NodeList The current Context Node List.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The AVT evaluated as a string
*
* @throws javax.xml.transform.TransformerException
*/
@@ -537,7 +537,7 @@
* Currently the only case we recognize is simple strings.
* ADDED 9/5/2000 to support compilation experiment
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the m_simpleString member of this AVT is not null
*/
public boolean isContextInsensitive()
{
1.8 +3 -3
xml-xalan/java/src/org/apache/xalan/templates/AVTPart.java
Index: AVTPart.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/AVTPart.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- AVTPart.java 2000/11/23 04:57:45 1.7
+++ AVTPart.java 2000/12/05 22:29:22 1.8
@@ -77,7 +77,7 @@
/**
* Get the AVT part as the original string.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the AVT part as the original string.
*/
public abstract String getSimpleString();
@@ -85,7 +85,7 @@
* Write the evaluated value into the given
* string buffer.
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The XPath context to use to evaluate this AVT.
* @param buf Buffer to write into.
* @param context The current source tree context.
* @param nsNode The current namespace context (stylesheet tree context).
@@ -101,7 +101,7 @@
/**
* Set the XPath support.
*
- * NEEDSDOC @param support
+ * @param support XPathContext to set.
*/
public void setXPathSupport(XPathContext support){}
}
1.7 +4 -4
xml-xalan/java/src/org/apache/xalan/templates/ElemApplyImport.java
Index: ElemApplyImport.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemApplyImport.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ElemApplyImport.java 2000/12/01 17:50:10 1.6
+++ ElemApplyImport.java 2000/12/05 22:29:22 1.7
@@ -80,7 +80,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return Token ID for xsl:apply-imports element types
*/
public int getXSLToken()
{
@@ -90,7 +90,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Element name
*/
public String getNodeName()
{
@@ -138,9 +138,9 @@
* Add a child to the child list.
* <!ELEMENT xsl:apply-imports EMPTY>
*
- * NEEDSDOC @param newChild
+ * @param newChild New element to append to this element's children list
*
- * NEEDSDOC ($objectName$) @return
+ * @return null, xsl:apply-Imports cannot have children
*
* @throws DOMException
*/
1.8 +10 -10
xml-xalan/java/src/org/apache/xalan/templates/ElemApplyTemplates.java
Index: ElemApplyTemplates.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemApplyTemplates.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ElemApplyTemplates.java 2000/12/01 17:50:11 1.7
+++ ElemApplyTemplates.java 2000/12/05 22:29:23 1.8
@@ -108,7 +108,7 @@
/**
* Get the mode attribute for this element.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The mode attribute for this element
*/
public QName getMode()
{
@@ -129,7 +129,7 @@
* regard to processing modes.
* @see <a href="http://www.w3.org/TR/xslt#built-in-rule";>built-in-rule in
XSLT Specification</a>
*
- * NEEDSDOC @param b
+ * @param b boolean value to set.
*/
public void setIsDefaultTemplate(boolean b)
{
@@ -140,7 +140,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return Token ID for this element types
*/
public int getXSLToken()
{
@@ -150,7 +150,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Element name
*/
public String getNodeName()
{
@@ -203,10 +203,10 @@
}
/**
- * NEEDSDOC Method needToPushParams
+ * Return whether or not we need to push default arguments on the stack
*
*
- * NEEDSDOC (needToPushParams) @return
+ * @return whether or not to push default arguments on the stack
*/
boolean needToPushParams()
{
@@ -214,11 +214,11 @@
}
/**
- * NEEDSDOC Method pushParams
+ * Push default arguments on the stack
*
*
* @param transformer non-null reference to the the current transform-time
state.
- * NEEDSDOC @param xctxt
+ * @param xctxt The XPath runtime state for this transformation.
* @param sourceNode non-null reference to the <a
href="http://www.w3.org/TR/xslt#dt-current-node";>current source node</a>.
* @param mode reference, which may be null, to the <a
href="http://www.w3.org/TR/xslt#modes";>current mode</a>.
*
@@ -238,10 +238,10 @@
}
/**
- * NEEDSDOC Method popParams
+ * Pop the stack of default arguments after we're done with them
*
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The XPath runtime state for this transformation.
*/
void popParams(XPathContext xctxt)
{
1.10 +8 -8
xml-xalan/java/src/org/apache/xalan/templates/ElemAttribute.java
Index: ElemAttribute.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemAttribute.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ElemAttribute.java 2000/12/01 17:50:11 1.9
+++ ElemAttribute.java 2000/12/05 22:29:23 1.10
@@ -97,7 +97,7 @@
/**
* Set the "name" attribute.
*
- * NEEDSDOC @param name
+ * @param name name attribute to set
*/
public void setName(AVT name)
{
@@ -107,7 +107,7 @@
/**
* Get the "name" attribute.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the "name" attribute.
*/
public AVT getName()
{
@@ -117,7 +117,7 @@
/**
* Set the "namespace" attribute.
*
- * NEEDSDOC @param name
+ * @param name Namspace attribute to set
*/
public void setNamespace(AVT name)
{
@@ -127,7 +127,7 @@
/**
* Get the "namespace" attribute.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the "namespace" attribute.
*/
public AVT getNamespace()
{
@@ -138,7 +138,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -148,7 +148,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element name
*/
public String getNodeName()
{
@@ -302,9 +302,9 @@
* %space-att;
* >
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to append to the list of this node's children
*
- * NEEDSDOC ($objectName$) @return
+ * @return The node we just appended to the children list
*
* @throws DOMException
*/
1.7 +6 -6
xml-xalan/java/src/org/apache/xalan/templates/ElemAttributeSet.java
Index: ElemAttributeSet.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemAttributeSet.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ElemAttributeSet.java 2000/12/01 17:50:11 1.6
+++ ElemAttributeSet.java 2000/12/05 22:29:23 1.7
@@ -93,7 +93,7 @@
* Set the "name" attribute.
* The name attribute specifies the name of the attribute set.
*
- * NEEDSDOC @param name
+ * @param name Name attribute to set
*/
public void setName(QName name)
{
@@ -104,7 +104,7 @@
* Get the "name" attribute.
* The name attribute specifies the name of the attribute set.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The name attribute of the attribute set
*/
public QName getName()
{
@@ -115,7 +115,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return Token ID of the element
*/
public int getXSLToken()
{
@@ -125,7 +125,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The name of this element
*/
public String getNodeName()
{
@@ -177,9 +177,9 @@
* use-attribute-sets %qnames; #IMPLIED
* >
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to be added to this node's list of children
*
- * NEEDSDOC ($objectName$) @return
+ * @return The child that was just added to the list of children
*
* @throws DOMException
*/
1.10 +14 -14
xml-xalan/java/src/org/apache/xalan/templates/ElemCallTemplate.java
Index: ElemCallTemplate.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemCallTemplate.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ElemCallTemplate.java 2000/12/01 17:50:11 1.9
+++ ElemCallTemplate.java 2000/12/05 22:29:24 1.10
@@ -96,7 +96,7 @@
* An xsl:call-template element invokes a template by name;
* it has a required name attribute that identifies the template to be
invoked.
*
- * NEEDSDOC @param name
+ * @param name Name attribute to set
*/
public void setName(QName name)
{
@@ -108,7 +108,7 @@
* An xsl:call-template element invokes a template by name;
* it has a required name attribute that identifies the template to be
invoked.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Name attribute of this element
*/
public QName getName()
{
@@ -124,7 +124,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -134,7 +134,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The name of this element
*/
public String getNodeName()
{
@@ -199,12 +199,12 @@
}
}
- /** NEEDSDOC Field m_paramElems */
+ /** Vector of xsl:param elements associated with this element */
protected Vector m_paramElems = null;
/**
- * Get the count xsl:sort elements associated with this element.
- * @return The number of xsl:sort elements.
+ * Get the count xsl:param elements associated with this element.
+ * @return The number of xsl:param elements.
*/
public int getParamElemCount()
{
@@ -212,11 +212,11 @@
}
/**
- * Get a xsl:sort element associated with this element.
+ * Get a xsl:param element associated with this element.
*
- * NEEDSDOC @param i
+ * @param i Index of element to find
*
- * NEEDSDOC ($objectName$) @return
+ * @return xsl:param element at given index
*/
public ElemWithParam getParamElem(int i)
{
@@ -224,9 +224,9 @@
}
/**
- * Set a xsl:sort element associated with this element.
+ * Set a xsl:param element associated with this element.
*
- * NEEDSDOC @param ParamElem
+ * @param ParamElem xsl:param element to set.
*/
public void setParamElem(ElemWithParam ParamElem)
{
@@ -245,9 +245,9 @@
* mode %qname; #IMPLIED
* >
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to this node's children list
*
- * NEEDSDOC ($objectName$) @return
+ * @return The child that was just added the children list
*
* @throws DOMException
*/
1.7 +5 -5
xml-xalan/java/src/org/apache/xalan/templates/ElemChoose.java
Index: ElemChoose.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemChoose.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ElemChoose.java 2000/12/01 17:50:12 1.6
+++ ElemChoose.java 2000/12/05 22:29:24 1.7
@@ -85,7 +85,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -95,7 +95,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
@@ -109,7 +109,7 @@
public ElemChoose(){}
/**
- * NEEDSDOC Method execute
+ * Execute the xsl:choose transformation.
*
*
* @param transformer non-null reference to the the current transform-time
state.
@@ -173,9 +173,9 @@
/**
* Add a child to the child list.
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to this node's child list
*
- * NEEDSDOC ($objectName$) @return
+ * @return The child that was just added to the child list
*
* @throws DOMException
*/
1.7 +5 -5
xml-xalan/java/src/org/apache/xalan/templates/ElemComment.java
Index: ElemComment.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemComment.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ElemComment.java 2000/12/01 17:50:12 1.6
+++ ElemComment.java 2000/12/05 22:29:24 1.7
@@ -83,7 +83,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -93,7 +93,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This element's name
*/
public String getNodeName()
{
@@ -101,7 +101,7 @@
}
/**
- * NEEDSDOC Method execute
+ * Execute the xsl:comment transformation
*
*
* @param transformer non-null reference to the the current transform-time
state.
@@ -140,9 +140,9 @@
/**
* Add a child to the child list.
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to this node's child list
*
- * NEEDSDOC ($objectName$) @return
+ * @return Child that was just added to child list
*
* @throws DOMException
*/
1.9 +2 -2
xml-xalan/java/src/org/apache/xalan/templates/ElemCopy.java
Index: ElemCopy.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemCopy.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ElemCopy.java 2000/12/01 17:50:12 1.8
+++ ElemCopy.java 2000/12/05 22:29:25 1.9
@@ -91,7 +91,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -101,7 +101,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This element's name
*/
public String getNodeName()
{
1.9 +7 -7
xml-xalan/java/src/org/apache/xalan/templates/ElemCopyOf.java
Index: ElemCopyOf.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemCopyOf.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ElemCopyOf.java 2000/12/01 17:50:12 1.8
+++ ElemCopyOf.java 2000/12/05 22:29:25 1.9
@@ -93,7 +93,7 @@
* Set the "select" attribute.
* The required select attribute contains an expression.
*
- * NEEDSDOC @param expr
+ * @param expr Expression for select attribute
*/
public void setSelect(XPath expr)
{
@@ -101,10 +101,10 @@
}
/**
- * Get the "use-attribute-sets" attribute.
+ * Get the "select" attribute.
* The required select attribute contains an expression.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Expression for select attribute
*/
public XPath getSelect()
{
@@ -115,7 +115,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -125,7 +125,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
@@ -234,9 +234,9 @@
/**
* Add a child to the child list.
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to this node's child list
*
- * NEEDSDOC ($objectName$) @return
+ * @return Child just added to child list
*
* @throws DOMException
*/
1.11 +7 -7
xml-xalan/java/src/org/apache/xalan/templates/ElemElement.java
Index: ElemElement.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemElement.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- ElemElement.java 2000/12/01 17:50:13 1.10
+++ ElemElement.java 2000/12/05 22:29:25 1.11
@@ -70,7 +70,7 @@
/**
* <meta name="usage" content="advanced"/>
- * Implement xsl:decimal-format.
+ * Implement xsl:element
* <pre>
* <!ELEMENT xsl:element %template;>
* <!ATTLIST xsl:element
@@ -98,7 +98,7 @@
* It is an error if the string that results from instantiating the
* attribute value template is not a QName.
*
- * NEEDSDOC @param v
+ * @param v Name attribute to set for this element
*/
public void setName(AVT v)
{
@@ -111,7 +111,7 @@
* It is an error if the string that results from instantiating the
* attribute value template is not a QName.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Name attribute for this element
*/
public AVT getName()
{
@@ -133,7 +133,7 @@
* instantiating the attribute value template should be a URI reference.
* It is not an error if the string is not a syntactically legal URI
reference.
*
- * NEEDSDOC @param v
+ * @param v NameSpace attribute to set for this element
*/
public void setNamespace(AVT v)
{
@@ -147,7 +147,7 @@
* instantiating the attribute value template should be a URI reference.
* It is not an error if the string is not a syntactically legal URI
reference.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Namespace attribute for this element
*/
public AVT getNamespace()
{
@@ -163,7 +163,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -173,7 +173,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This element's name
*/
public String getNodeName()
{
1.17 +16 -16
xml-xalan/java/src/org/apache/xalan/templates/ElemExtensionCall.java
Index: ElemExtensionCall.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemExtensionCall.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- ElemExtensionCall.java 2000/12/01 17:50:13 1.16
+++ ElemExtensionCall.java 2000/12/05 22:29:26 1.17
@@ -91,31 +91,31 @@
// ExtensionNSHandler nsh;
- /** NEEDSDOC Field m_extns */
+ /** The Namespace URI for this extension call element */
String m_extns;
// String m_extHandlerLookup;
- /** NEEDSDOC Field isAvailable */
+ /** Flag indicating if the extension is available for execution */
transient boolean isAvailable = false;
- /** NEEDSDOC Field m_lang */
+ /** Language used by extension */
String m_lang;
- /** NEEDSDOC Field m_srcURL */
+ /** URL pointing to extension */
String m_srcURL;
- /** NEEDSDOC Field m_scriptSrc */
+ /** Source for script */
String m_scriptSrc;
- /** NEEDSDOC Field m_decl */
+ /** Declaration for Extension element */
ElemExtensionDecl m_decl = null;
/**
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ [EMAIL PROTECTED] The token ID for this element
*/
public int getXSLToken()
{
@@ -125,7 +125,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
// public String getNodeName()
@@ -195,13 +195,13 @@
}
/**
- * NEEDSDOC Method getElemExtensionDecl
+ * Return the ElemExtensionDecl for this extension element
*
*
- * NEEDSDOC @param stylesheet
- * NEEDSDOC @param namespace
+ * @param stylesheet Stylesheet root associated with this extension element
+ * @param namespace Namespace associated with this extension element
*
- * NEEDSDOC (getElemExtensionDecl) @return
+ * @return the ElemExtensionDecl for this extension element.
*/
private ElemExtensionDecl getElemExtensionDecl(StylesheetRoot stylesheet,
String namespace)
@@ -331,9 +331,9 @@
/**
* Return the raw value of the attribute.
*
- * NEEDSDOC @param rawName
+ * @param rawName Raw name of the attribute to get
*
- * NEEDSDOC ($objectName$) @return
+ * @return the raw value of the attribute or null if not found
*/
public String getAttribute(String rawName)
{
@@ -353,11 +353,11 @@
* Value Template (in other words, you can use curly expressions
* such as href="http://{website}";.
*
- * NEEDSDOC @param rawName
+ * @param rawName Raw name of the attribute to get
* @param sourceNode non-null reference to the <a
href="http://www.w3.org/TR/xslt#dt-current-node";>current source node</a>.
* @param transformer non-null reference to the the current transform-time
state.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the value of the attribute
*
* @throws TransformerException
*/
1.13 +27 -27
xml-xalan/java/src/org/apache/xalan/templates/ElemExtensionDecl.java
Index: ElemExtensionDecl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemExtensionDecl.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- ElemExtensionDecl.java 2000/11/23 04:57:51 1.12
+++ ElemExtensionDecl.java 2000/12/05 22:29:26 1.13
@@ -74,7 +74,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class ElemExtensionDecl <needs-comment/>
+ * Implement the declaration of an extension element
*/
public class ElemExtensionDecl extends ElemTemplateElement
{
@@ -89,14 +89,14 @@
// System.out.println("ElemExtensionDecl ctor");
}
- /** NEEDSDOC Field m_prefix */
+ /** Prefix string for this extension element */
private String m_prefix = null;
/**
- * NEEDSDOC Method setPrefix
+ * Set the prefix for this extension element
*
*
- * NEEDSDOC @param v
+ * @param v Prefix to set for this extension element
*/
public void setPrefix(String v)
{
@@ -104,24 +104,24 @@
}
/**
- * NEEDSDOC Method getPrefix
+ * Set the prefix for this extension element
*
*
- * NEEDSDOC (getPrefix) @return
+ * @return Prefix for this extension element
*/
public String getPrefix()
{
return m_prefix;
}
- /** NEEDSDOC Field m_functions */
+ /** StringVector holding the names of functions defined in this extension
*/
private StringVector m_functions = new StringVector();
/**
- * NEEDSDOC Method setFunctions
+ * Set the names of functions defined in this extension
*
*
- * NEEDSDOC @param v
+ * @param v StringVector holding the names of functions defined in this
extension
*/
public void setFunctions(StringVector v)
{
@@ -129,10 +129,10 @@
}
/**
- * NEEDSDOC Method getFunctions
+ * Get the names of functions defined in this extension
*
*
- * NEEDSDOC (getFunctions) @return
+ * @return StringVector holding the names of functions defined in this
extension
*/
public StringVector getFunctions()
{
@@ -140,12 +140,12 @@
}
/**
- * NEEDSDOC Method getFunction
+ * Get a function at a given index in this extension element
*
*
- * NEEDSDOC @param i
+ * @param i Index of function to get
*
- * NEEDSDOC (getFunction) @return
+ * @return Name of Function at given index
*
* @throws ArrayIndexOutOfBoundsException
*/
@@ -159,24 +159,24 @@
}
/**
- * NEEDSDOC Method getFunctionCount
+ * Get count of functions defined in this extension element
*
*
- * NEEDSDOC (getFunctionCount) @return
+ * @return count of functions defined in this extension element
*/
public int getFunctionCount()
{
return (null != m_functions) ? m_functions.size() : 0;
}
- /** NEEDSDOC Field m_elements */
+ /** StringVector of elements defined in this extension */
private StringVector m_elements = null;
/**
- * NEEDSDOC Method setElements
+ * Set StringVector of elements for this extension
*
*
- * NEEDSDOC @param v
+ * @param v StringVector of elements to set
*/
public void setElements(StringVector v)
{
@@ -184,10 +184,10 @@
}
/**
- * NEEDSDOC Method getElements
+ * Get StringVector of elements defined for this extension
*
*
- * NEEDSDOC (getElements) @return
+ * @return StringVector of elements defined for this extension
*/
public StringVector getElements()
{
@@ -195,12 +195,12 @@
}
/**
- * NEEDSDOC Method getElement
+ * Get the element at the given index
*
*
- * NEEDSDOC @param i
+ * @param i Index of element to get
*
- * NEEDSDOC (getElement) @return
+ * @return The element at the given index
*
* @throws ArrayIndexOutOfBoundsException
*/
@@ -214,10 +214,10 @@
}
/**
- * NEEDSDOC Method getElementCount
+ * Return the count of elements defined for this extension element
*
*
- * NEEDSDOC (getElementCount) @return
+ * @return the count of elements defined for this extension element
*/
public int getElementCount()
{
@@ -228,7 +228,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
1.4 +12 -12
xml-xalan/java/src/org/apache/xalan/templates/ElemExtensionScript.java
Index: ElemExtensionScript.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemExtensionScript.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ElemExtensionScript.java 2000/10/30 18:49:47 1.3
+++ ElemExtensionScript.java 2000/12/05 22:29:26 1.4
@@ -58,7 +58,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class ElemExtensionScript <needs-comment/>
+ * Implement Script extension element
*/
public class ElemExtensionScript extends ElemTemplateElement
{
@@ -73,14 +73,14 @@
// System.out.println("ElemExtensionScript ctor");
}
- /** NEEDSDOC Field m_lang */
+ /** Language used in extension */
private String m_lang = null;
/**
- * NEEDSDOC Method setLang
+ * Set language used by extension
*
*
- * NEEDSDOC @param v
+ * @param v Language used by extension
*/
public void setLang(String v)
{
@@ -88,24 +88,24 @@
}
/**
- * NEEDSDOC Method getLang
+ * Get language used by extension
*
*
- * NEEDSDOC (getLang) @return
+ * @return Language used by extension
*/
public String getLang()
{
return m_lang;
}
- /** NEEDSDOC Field m_src */
+ /** Extension handler */
private String m_src = null;
/**
- * NEEDSDOC Method setSrc
+ * Set Extension handler name for this extension
*
*
- * NEEDSDOC @param v
+ * @param v Extension handler name to set
*/
public void setSrc(String v)
{
@@ -113,10 +113,10 @@
}
/**
- * NEEDSDOC Method getSrc
+ * Get Extension handler name for this extension
*
*
- * NEEDSDOC (getSrc) @return
+ * @return Extension handler name
*/
public String getSrc()
{
@@ -127,7 +127,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
1.7 +2 -2
xml-xalan/java/src/org/apache/xalan/templates/ElemFallback.java
Index: ElemFallback.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemFallback.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ElemFallback.java 2000/12/01 17:50:13 1.6
+++ ElemFallback.java 2000/12/05 22:29:27 1.7
@@ -84,7 +84,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -94,7 +94,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The Element's name
*/
public String getNodeName()
{
1.12 +28 -27
xml-xalan/java/src/org/apache/xalan/templates/ElemForEach.java
Index: ElemForEach.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemForEach.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ElemForEach.java 2000/12/01 17:50:13 1.11
+++ ElemForEach.java 2000/12/05 22:29:27 1.12
@@ -113,7 +113,7 @@
/**
* Set the "select" attribute.
*
- * NEEDSDOC @param xpath
+ * @param xpath The XPath expression for the "select" attribute.
*/
public void setSelect(XPath xpath)
{
@@ -121,9 +121,9 @@
}
/**
- * Set the "select" attribute.
+ * Get the "select" attribute.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The XPath expression for the "select" attribute.
*/
public XPath getSelect()
{
@@ -131,9 +131,10 @@
}
/**
- * Set the "select" attribute.
+ * Get the "select" attribute or default selection pattern.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the "select" attribute or if null, the
+ * default selection pattern ("node()")
*/
public XPath getSelectOrDefault()
{
@@ -141,7 +142,7 @@
? getStylesheetRoot().m_selectDefault : m_selectExpression;
}
- /** NEEDSDOC Field m_sortElems */
+ /** Vector containing the xsl:sort elements associated with this element
*/
protected Vector m_sortElems = null;
/**
@@ -156,9 +157,9 @@
/**
* Get a xsl:sort element associated with this element.
*
- * NEEDSDOC @param i
+ * @param i Index of xsl:sort element to get
*
- * NEEDSDOC ($objectName$) @return
+ * @return xsl:sort element at given index
*/
public ElemSort getSortElem(int i)
{
@@ -168,7 +169,7 @@
/**
* Set a xsl:sort element associated with this element.
*
- * NEEDSDOC @param sortElem
+ * @param sortElem xsl:sort element to set
*/
public void setSortElem(ElemSort sortElem)
{
@@ -183,7 +184,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -193,7 +194,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
@@ -201,7 +202,7 @@
}
/**
- * NEEDSDOC Method execute
+ * Execute the xsl:for-each transformation
*
*
* @param transformer non-null reference to the the current transform-time
state.
@@ -231,10 +232,10 @@
}
/**
- * NEEDSDOC Method getTemplateMatch
+ * Get template element associated with this
*
*
- * NEEDSDOC (getTemplateMatch) @return
+ * @return template element associated with this (itself)
*/
protected ElemTemplateElement getTemplateMatch()
{
@@ -242,14 +243,14 @@
}
/**
- * NEEDSDOC Method sortNodes
+ * Sort given nodes
*
*
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param keys
- * NEEDSDOC @param sourceNodes
+ * @param xctxt The XPath runtime state for the sort.
+ * @param keys Vector of sort keyx
+ * @param sourceNodes Iterator of nodes to sort
*
- * NEEDSDOC (sortNodes) @return
+ * @return iterator of sorted nodes
*
* @throws TransformerException
*/
@@ -292,10 +293,10 @@
}
/**
- * NEEDSDOC Method needToPushParams
+ * Return whether or not default parameters need to be pushed into stack
*
*
- * NEEDSDOC (needToPushParams) @return
+ * @return False, no need to push parameters here.
*/
boolean needToPushParams()
{
@@ -303,11 +304,11 @@
}
/**
- * NEEDSDOC Method pushParams
+ * Push default parameters into the stack
*
*
* @param transformer non-null reference to the the current transform-time
state.
- * NEEDSDOC @param xctxt
+ * @param xctxt The XPath runtime state.
* @param sourceNode non-null reference to the <a
href="http://www.w3.org/TR/xslt#dt-current-node";>current source node</a>.
* @param mode reference, which may be null, to the <a
href="http://www.w3.org/TR/xslt#modes";>current mode</a>.
*
@@ -324,10 +325,10 @@
}
/**
- * NEEDSDOC Method popParams
+ * Pop Default parameters from the stack
*
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The XPath runtime state.
*/
void popParams(XPathContext xctxt)
{
@@ -530,9 +531,9 @@
* mode %qname; #IMPLIED
* >
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to child list
*
- * NEEDSDOC ($objectName$) @return
+ * @return Child just added to child list
*
* @throws DOMException
*/
1.7 +4 -4 xml-xalan/java/src/org/apache/xalan/templates/ElemIf.java
Index: ElemIf.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemIf.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ElemIf.java 2000/12/01 17:50:14 1.6
+++ ElemIf.java 2000/12/05 22:29:27 1.7
@@ -93,7 +93,7 @@
* Set the "test" attribute.
* The xsl:if element must have a test attribute, which specifies an
expression.
*
- * NEEDSDOC @param v
+ * @param v test attribute to set
*/
public void setTest(XPath v)
{
@@ -104,7 +104,7 @@
* Get the "test" attribute.
* The xsl:if element must have a test attribute, which specifies an
expression.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the "test" attribute for this element.
*/
public XPath getTest()
{
@@ -115,7 +115,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -125,7 +125,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the element's name
*/
public String getNodeName()
{
1.7 +4 -4
xml-xalan/java/src/org/apache/xalan/templates/ElemMessage.java
Index: ElemMessage.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemMessage.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ElemMessage.java 2000/12/01 17:50:14 1.6
+++ ElemMessage.java 2000/12/05 22:29:28 1.7
@@ -95,7 +95,7 @@
* XSLT transformer should terminate processing after sending
* the message. The default value is no.
*
- * NEEDSDOC @param v
+ * @param v Value to set for "terminate" attribute.
*/
public void setTerminate(boolean v)
{
@@ -108,7 +108,7 @@
* XSLT transformer should terminate processing after sending
* the message. The default value is no.
*
- * NEEDSDOC ($objectName$) @return
+ * @return value of "terminate" attribute.
*/
public boolean getTerminate()
{
@@ -119,7 +119,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -129,7 +129,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return name of the element
*/
public String getNodeName()
{
1.12 +74 -67
xml-xalan/java/src/org/apache/xalan/templates/ElemNumber.java
Index: ElemNumber.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemNumber.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ElemNumber.java 2000/12/01 17:50:14 1.11
+++ ElemNumber.java 2000/12/05 22:29:28 1.12
@@ -120,7 +120,7 @@
* current node has an expanded-name, with the same expanded-name
* as the current node.
*
- * NEEDSDOC @param v
+ * @param v Value to set for "count" attribute.
*/
public void setCount(XPath v)
{
@@ -136,7 +136,7 @@
* current node has an expanded-name, with the same expanded-name
* as the current node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of "count" attribute.
*/
public XPath getCount()
{
@@ -165,7 +165,7 @@
* Only nodes after the first node before the
* current node that match the from pattern are considered.
*
- * NEEDSDOC @param v
+ * @param v Value to set for "from" attribute.
*/
public void setFrom(XPath v)
{
@@ -182,7 +182,7 @@
* Only nodes after the first node before the
* current node that match the from pattern are considered.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of "from" attribute.
*/
public XPath getFrom()
{
@@ -222,7 +222,7 @@
* be considered; it has the values single, multiple or any. The default
* is single.
*
- * NEEDSDOC @param v
+ * @param v Value to set for "level" attribute.
*/
public void setLevel(int v)
{
@@ -235,7 +235,7 @@
* be considered; it has the values single, multiple or any. The default
* is single.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of "level" attribute.
*/
public int getLevel()
{
@@ -255,7 +255,7 @@
* and the resulting object is converted to a number as if by a call to the
* number function.
*
- * NEEDSDOC @param v
+ * @param v Value to set for "value" attribute.
*/
public void setValue(XPath v)
{
@@ -268,7 +268,7 @@
* and the resulting object is converted to a number as if by a call to the
* number function.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of "value" attribute.
*/
public XPath getValue()
{
@@ -288,7 +288,7 @@
* numbers into a string.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set for "format" attribute.
*/
public void setFormat(AVT v)
{
@@ -301,7 +301,7 @@
* numbers into a string.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of "format" attribute.
*/
public AVT getFormat()
{
@@ -323,7 +323,7 @@
* Implementers should document for which languages they support numbering.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set for "lang" attribute.
*/
public void setLang(AVT v)
{
@@ -339,7 +339,7 @@
* Implementers should document for which languages they support numbering.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value ofr "lang" attribute.
*/
public AVT getLang()
{
@@ -358,7 +358,7 @@
* that use letters.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set for "letter-value" attribute.
*/
public void setLetterValue(AVT v)
{
@@ -371,7 +371,7 @@
* that use letters.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value to set for "letter-value" attribute.
*/
public AVT getLetterValue()
{
@@ -392,7 +392,7 @@
* numbering sequences.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set for "grouping-separator" attribute.
*/
public void setGroupingSeparator(AVT v)
{
@@ -406,7 +406,7 @@
* numbering sequences.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of "grouping-separator" attribute.
*/
public AVT getGroupingSeparator()
{
@@ -423,7 +423,7 @@
* The optional grouping-size specifies the size (normally 3) of the
grouping.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set for "grouping-size" attribute.
*/
public void setGroupingSize(AVT v)
{
@@ -435,7 +435,7 @@
* The optional grouping-size specifies the size (normally 3) of the
grouping.
* @see <a href="http://www.w3.org/TR/xslt#convert";>convert in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of "grouping-size" attribute.
*/
public AVT getGroupingSize()
{
@@ -472,7 +472,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -482,7 +482,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
@@ -523,9 +523,9 @@
/**
* Add a child to the child list.
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to child list
*
- * NEEDSDOC ($objectName$) @return
+ * @return Child just added to child list
*
* @throws DOMException
*/
@@ -545,14 +545,14 @@
* and a context, find the first ancestor that matches the
* pattern (including the context handed in).
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The XPath runtime state for this.
* @param fromMatchPattern The ancestor must match this pattern.
* @param countMatchPattern The ancestor must also match this pattern.
* @param context The node that "." expresses.
* @param namespaceContext The context in which namespaces in the
* queries are supposed to be expanded.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the first ancestor that matches the given pattern
*
* @throws javax.xml.transform.TransformerException
*/
@@ -593,17 +593,15 @@
* Given a 'from' pattern (ala xsl:number), a match pattern
* and a context, find the first ancestor that matches the
* pattern (including the context handed in).
- * @param matchPatternString The match pattern.
- * @param node The node that "." expresses.
- *
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param fromMatchPattern
- * NEEDSDOC @param countMatchPattern
- * NEEDSDOC @param context
+ * @param xctxt The XPath runtime state for this.
+ * @param fromMatchPattern The ancestor must match this pattern.
+ * @param countMatchPattern The ancestor must also match this pattern.
+ * @param context The node that "." expresses.
* @param namespaceContext The context in which namespaces in the
* queries are supposed to be expanded.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the first preceding, ancestor or self node that
+ * matches the given pattern
*
* @throws javax.xml.transform.TransformerException
*/
@@ -657,10 +655,10 @@
/**
* Get the count match pattern, or a default value.
*
- * NEEDSDOC @param support
- * NEEDSDOC @param contextNode
+ * @param support The XPath runtime state for this.
+ * @param contextNode The node that "." expresses.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the count match pattern, or a default value.
*
* @throws javax.xml.transform.TransformerException
*/
@@ -719,10 +717,10 @@
/**
* Given an XML source node, get the count according to the
* parameters set up by the xsl:number attributes.
- * @param transformer The node being counted.
+ * @param transformer non-null reference to the the current transform-time
state.
* @param sourceNode The source node being counted.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The count of nodes
*
* @throws TransformerException
*/
@@ -777,10 +775,10 @@
/**
* Get the previous node to be counted.
*
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param pos
+ * @param xctxt The XPath runtime state for this.
+ * @param pos The current node
*
- * NEEDSDOC ($objectName$) @return
+ * @return the previous node to be counted.
*
* @throws TransformerException
*/
@@ -865,10 +863,10 @@
/**
* Get the target node that will be counted..
*
- * NEEDSDOC @param xctxt
+ * @param xctxt The XPath runtime state for this.
* @param sourceNode non-null reference to the <a
href="http://www.w3.org/TR/xslt#dt-current-node";>current source node</a>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the target node that will be counted
*
* @throws TransformerException
*/
@@ -897,12 +895,14 @@
/**
* Get the ancestors, up to the root, that match the
* pattern.
+ *
* @param patterns if non-null, count only nodes
* that match this pattern, if null count all ancestors.
- *
- * NEEDSDOC @param xctxt
+ * @param xctxt The XPath runtime state for this.
* @param node Count this node and it's ancestors.
- * NEEDSDOC @param stopAtFirstFound
+ * @param stopAtFirstFound Flag indicating to stop after the
+ * first node is found (difference between level = single
+ * or multiple)
* @return The number of ancestors that match the pattern.
*
* @throws javax.xml.transform.TransformerException
@@ -955,9 +955,10 @@
* Get the locale we should be using.
*
* @param transformer non-null reference to the the current transform-time
state.
- * NEEDSDOC @param contextNode
+ * @param contextNode The node that "." expresses.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The locale to use. May be specified by "lang" attribute,
+ * but if not, use default locale on the system.
*
* @throws TransformerException
*/
@@ -1000,12 +1001,12 @@
}
/**
- *
+ * Get the number formatter to be used the format the numbers
*
* @param transformer non-null reference to the the current transform-time
state.
- * NEEDSDOC @param contextNode
+ * @param contextNode The node that "." expresses.
*
- * NEEDSDOC ($objectName$) @return
+ * ($objectName$) @return The number formatter to be used
*
* @throws TransformerException
*/
@@ -1054,11 +1055,11 @@
/**
* Format a vector of numbers into a formatted string.
+ *
* @param xslNumberElement Element that takes %conversion-atts; attributes.
- *
* @param transformer non-null reference to the the current transform-time
state.
* @param list Array of one or more integer numbers.
- * NEEDSDOC @param contextNode
+ * @param contextNode The node that "." expresses.
* @return String that represents list according to
* %conversion-atts; attributes.
* TODO: Optimize formatNumberList so that it caches the last count and
@@ -1211,20 +1212,22 @@
*/
/**
- * NEEDSDOC Method getFormattedNumber
+ * Format the given number and store it in the given buffer
*
*
* @param transformer non-null reference to the the current transform-time
state.
- * NEEDSDOC @param contextNode
- * NEEDSDOC @param numberType
- * NEEDSDOC @param numberWidth
- * NEEDSDOC @param listElement
- * NEEDSDOC @param formattedNumber
+ * @param contextNode The node that "." expresses.
+ * @param numberType Type to format to
+ * @param numberWidth Maximum length of formatted number
+ * @param listElement Number to format
+ * @param formattedNumber Buffer to store formatted number
*
* @throws javax.xml.transform.TransformerException
*/
private void getFormattedNumber(
- TransformerImpl transformer, Node contextNode, char numberType,
int numberWidth, int listElement, FastStringBuffer formattedNumber)
+ TransformerImpl transformer, Node contextNode,
+ char numberType, int numberWidth, int listElement,
+ FastStringBuffer formattedNumber)
throws javax.xml.transform.TransformerException
{
@@ -1500,6 +1503,7 @@
/**
* Convert a long integer into alphabetic counting, in other words
* count using the sequence A B C ... Z.
+ *
* @param val Value to convert -- must be greater than zero.
* @param table a table containing one character for each digit in the
radix
* @return String representing alpha count of number.
@@ -1523,11 +1527,12 @@
/**
* Convert a long integer into alphabetic counting, in other words
* count using the sequence A B C ... Z AA AB AC.... etc.
+ *
* @param val Value to convert -- must be greater than zero.
* @param table a table containing one character for each digit in the
radix
- * NEEDSDOC @param aTable
- * NEEDSDOC @param stringBuf
- * @return String representing alpha count of number.
+ * @param aTable Array of alpha characters representing numbers
+ * @param stringBuf Buffer where to save the string representing alpha
count of number.
+ *
* @see TransformerImpl#DecimalToRoman
*
* Note that the radix of the conversion is inferred from the size
@@ -1624,9 +1629,11 @@
/**
* Convert a long integer into traditional alphabetic counting, in other
words
* count using the traditional numbering.
+ *
* @param val Value to convert -- must be greater than zero.
* @param table a table containing one character for each digit in the
radix
- * NEEDSDOC @param thisBundle
+ * @param thisBundle Resource bundle to use
+ *
* @return String representing alpha count of number.
* @see XSLProcessor#DecimalToRoman
*
@@ -1888,19 +1895,19 @@
class NumberFormatStringTokenizer
{
- /** NEEDSDOC Field currentPosition */
+ /** Current position in the format string */
private int currentPosition;
- /** NEEDSDOC Field maxPosition */
+ /** Index of last character in the format string */
private int maxPosition;
- /** NEEDSDOC Field str */
+ /** Format string to be tokenized */
private String str;
/**
* Construct a NumberFormatStringTokenizer.
*
- * NEEDSDOC @param str
+ * @param str Format string to be tokenized
*/
public NumberFormatStringTokenizer(String str)
{
1.4 +2 -2
xml-xalan/java/src/org/apache/xalan/templates/ElemOtherwise.java
Index: ElemOtherwise.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemOtherwise.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ElemOtherwise.java 2000/10/30 18:49:52 1.3
+++ ElemOtherwise.java 2000/12/05 22:29:29 1.4
@@ -80,7 +80,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for this element
*/
public int getXSLToken()
{
@@ -90,7 +90,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
1.8 +6 -6 xml-xalan/java/src/org/apache/xalan/templates/ElemPI.java
Index: ElemPI.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemPI.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ElemPI.java 2000/12/01 17:50:14 1.7
+++ ElemPI.java 2000/12/05 22:29:29 1.8
@@ -94,7 +94,7 @@
* Set the "name" attribute.
* DJD
*
- * NEEDSDOC @param v
+ * @param v Value for the name attribute
*/
public void setName(AVT v)
{
@@ -105,7 +105,7 @@
* Get the "name" attribute.
* DJD
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "name" attribute
*/
public AVT getName()
{
@@ -116,7 +116,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for the element
*/
public int getXSLToken()
{
@@ -126,7 +126,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
@@ -189,9 +189,9 @@
/**
* Add a child to the child list.
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to child list
*
- * NEEDSDOC ($objectName$) @return
+ * @return The child just added to the child list
*
* @throws DOMException
*/
1.8 +3 -3
xml-xalan/java/src/org/apache/xalan/templates/ElemParam.java
Index: ElemParam.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemParam.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ElemParam.java 2000/12/01 17:50:15 1.7
+++ ElemParam.java 2000/12/05 22:29:29 1.8
@@ -92,7 +92,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID of the element
*/
public int getXSLToken()
{
@@ -102,7 +102,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
@@ -112,7 +112,7 @@
/**
* Copy constructor.
*
- * NEEDSDOC @param param
+ * @param param Element from an xsl:param
*
* @throws TransformerException
*/
1.5 +14 -14
xml-xalan/java/src/org/apache/xalan/templates/ElemSort.java
Index: ElemSort.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemSort.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ElemSort.java 2000/10/30 18:49:55 1.4
+++ ElemSort.java 2000/12/05 22:29:29 1.5
@@ -101,7 +101,7 @@
* is ., which will cause the string-value of the current node to
* be used as the sort key.
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "select" attribute
*/
public void setSelect(XPath v)
{
@@ -124,7 +124,7 @@
* is ., which will cause the string-value of the current node to
* be used as the sort key.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "select" attribute
*/
public XPath getSelect()
{
@@ -142,7 +142,7 @@
* range of values as xml:lang [XML]; if no lang value is
* specified, the language should be determined from the system
environment.
*
- * NEEDSDOC @param v
+ * @param v The value to set for the "lang" attribute
*/
public void setLang(AVT v)
{
@@ -155,7 +155,7 @@
* range of values as xml:lang [XML]; if no lang value is
* specified, the language should be determined from the system
environment.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "lang" attribute
*/
public AVT getLang()
{
@@ -198,7 +198,7 @@
* leverage XML Schemas to define further values for this
* attribute.</blockquote>
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "data-type" attribute
*/
public void setDataType(AVT v)
{
@@ -235,7 +235,7 @@
* leverage XML Schemas to define further values for this
* attribute.</blockquote>
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "data-type" attribute
*/
public AVT getDataType()
{
@@ -254,7 +254,7 @@
* or descending order; ascending specifies ascending order; descending
* specifies descending order; the default is ascending.
*
- * NEEDSDOC @param v
+ * @param v The value to set for the "order" attribute
*/
public void setOrder(AVT v)
{
@@ -267,7 +267,7 @@
* or descending order; ascending specifies ascending order; descending
* specifies descending order; the default is ascending.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "order" attribute
*/
public AVT getOrder()
{
@@ -289,7 +289,7 @@
* case-order="upper-first" and a A b B are sorted with
case-order="lower-first".
* The default value is language dependent.
*
- * NEEDSDOC @param v
+ * @param v The value to set for the "case-order" attribute
*/
public void setCaseOrder(AVT v)
{
@@ -305,7 +305,7 @@
* case-order="upper-first" and a A b B are sorted with
case-order="lower-first".
* The default value is language dependent.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "case-order" attribute
*/
public AVT getCaseOrder()
{
@@ -316,7 +316,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID of the element
*/
public int getXSLToken()
{
@@ -326,7 +326,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
@@ -336,9 +336,9 @@
/**
* Add a child to the child list.
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to the child list
*
- * NEEDSDOC ($objectName$) @return
+ * @return Child just added to the child list
*
* @throws DOMException
*/
1.9 +21 -20
xml-xalan/java/src/org/apache/xalan/templates/ElemTemplate.java
Index: ElemTemplate.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemTemplate.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ElemTemplate.java 2000/12/01 17:50:15 1.8
+++ ElemTemplate.java 2000/12/05 22:29:30 1.9
@@ -92,10 +92,10 @@
public class ElemTemplate extends ElemTemplateElement
{
- /** NEEDSDOC Field m_publicId */
+ /** The public identifier for the current document event */
private String m_publicId;
- /** NEEDSDOC Field m_systemId */
+ /** The system identifier for the current document event */
private String m_systemId;
/**
@@ -128,7 +128,7 @@
/**
* Set the location information for this element.
*
- * NEEDSDOC @param locator
+ * @param locator SourceLocator holding location information
*/
public void setLocaterInfo(SourceLocator locator)
{
@@ -148,9 +148,10 @@
private Stylesheet m_stylesheet;
/**
- * Get the owning stylesheet.
- *
- * NEEDSDOC ($objectName$) @return
+ * Get the stylesheet composed (resolves includes and
+ * imports and has methods on it that return "composed" properties.
+ *
+ * @return The stylesheet composed.
*/
public StylesheetComposed getStylesheetComposed()
{
@@ -160,7 +161,7 @@
/**
* Get the owning stylesheet.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The owning stylesheet.
*/
public Stylesheet getStylesheet()
{
@@ -170,7 +171,7 @@
/**
* Set the owning stylesheet.
*
- * NEEDSDOC @param sheet
+ * @param sheet The owning stylesheet for this element
*/
public void setStylesheet(Stylesheet sheet)
{
@@ -178,9 +179,9 @@
}
/**
- * Get the owning stylesheet.
+ * Get the root stylesheet.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The root stylesheet for this element
*/
public StylesheetRoot getStylesheetRoot()
{
@@ -202,7 +203,7 @@
* value of the match attribute to contain a VariableReference.
* @see <a href="http://www.w3.org/TR/xslt#patterns";>patterns in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "match" attribute
*/
public void setMatch(XPath v)
{
@@ -218,7 +219,7 @@
* value of the match attribute to contain a VariableReference.
* @see <a href="http://www.w3.org/TR/xslt#patterns";>patterns in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "match" attribute
*/
public XPath getMatch()
{
@@ -237,7 +238,7 @@
* also have a match attribute.
* @see <a
href="http://www.w3.org/TR/xslt#named-templates";>named-templates in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set the "name" attribute
*/
public void setName(QName v)
{
@@ -251,7 +252,7 @@
* also have a match attribute.
* @see <a
href="http://www.w3.org/TR/xslt#named-templates";>named-templates in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "name" attribute
*/
public QName getName()
{
@@ -271,7 +272,7 @@
* does not have a match attribute, it must not have a mode attribute.
* @see <a href="http://www.w3.org/TR/xslt#modes";>modes in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set the "mode" attribute
*/
public void setMode(QName v)
{
@@ -285,7 +286,7 @@
* does not have a match attribute, it must not have a mode attribute.
* @see <a href="http://www.w3.org/TR/xslt#modes";>modes in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "mode" attribute
*/
public QName getMode()
{
@@ -306,7 +307,7 @@
* Number with an optional leading minus sign (-).
* @see <a href="http://www.w3.org/TR/xslt#conflict";>conflict in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v The value to set for the "priority" attribute
*/
public void setPriority(double v)
{
@@ -321,7 +322,7 @@
* Number with an optional leading minus sign (-).
* @see <a href="http://www.w3.org/TR/xslt#conflict";>conflict in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "priority" attribute
*/
public double getPriority()
{
@@ -332,7 +333,7 @@
* Get an int constant identifying the type of element.
* @see org.apache.xalan.templates.Constants
*
- * NEEDSDOC ($objectName$) @return
+ * @return The token ID for the element
*/
public int getXSLToken()
{
@@ -342,7 +343,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
1.28 +40 -38
xml-xalan/java/src/org/apache/xalan/templates/ElemTemplateElement.java
Index: ElemTemplateElement.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemTemplateElement.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- ElemTemplateElement.java 2000/12/04 22:45:38 1.27
+++ ElemTemplateElement.java 2000/12/05 22:29:30 1.28
@@ -128,7 +128,7 @@
/**
* Tell if this template is a compiled template.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Boolean flag indicating whether this is a compiled template
*/
public boolean isCompiledTemplate()
{
@@ -150,7 +150,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return An invalid node name
*/
public String getNodeName()
{
@@ -190,7 +190,7 @@
* on a Stylesheet object, which will Get the owning
* aggregated stylesheet, or that stylesheet if it is aggregated.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the owning "composed" stylesheet.
*/
public StylesheetComposed getStylesheetComposed()
{
@@ -202,7 +202,7 @@
* inheritance chain until it calls getStylesheet
* on a Stylesheet object, which will return itself.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the owning stylesheet
*/
public Stylesheet getStylesheet()
{
@@ -215,7 +215,7 @@
* on a Stylesheet object, which will return a reference
* to the root stylesheet.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the owning root stylesheet
*/
public StylesheetRoot getStylesheetRoot()
{
@@ -273,7 +273,7 @@
* Throw a template element runtime error. (Note: should we throw a
TransformerException instead?)
*
* @param msg Description of the error that occured.
- * NEEDSDOC @param args
+ * @param args Arguments to be used in the message
*/
public void error(int msg, Object[] args)
{
@@ -295,10 +295,10 @@
* first to remove it from its previous context. Failing to do so will
* damage the tree.
*
+ * @param newChild Child to be added to child list
*
- * NEEDSDOC ($objectName$) @return
+ * @return Child just added to the child list
* @exception DOMException
- * @param newChild
*/
public Node appendChild(Node newChild) throws DOMException
{
@@ -329,7 +329,7 @@
/**
* Tell if there are child nodes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if there are child nodes
*/
public boolean hasChildNodes()
{
@@ -339,7 +339,7 @@
/**
* Get the type of the node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Constant for this node type
*/
public short getNodeType()
{
@@ -349,7 +349,7 @@
/**
* Return the nodelist (same reference).
*
- * NEEDSDOC ($objectName$) @return
+ * @return The nodelist containing the child nodes (this)
*/
public NodeList getChildNodes()
{
@@ -363,10 +363,10 @@
* ... which is less well checked, but more convenient in some cases.
* Given that we assume only experts are calling this class, it might
* be preferable. It's less DOMish, though.
- * @param oldChild The child to remove. This operation is a no-op
+ *
+ * @param childETE The child to remove. This operation is a no-op
* if oldChild is not a child of this node.
*
- * NEEDSDOC @param childETE
* @return the removed child, or null if the specified
* node was not a child of this element.
*
@@ -399,10 +399,10 @@
/**
* Replace the old child with a new child.
*
- * NEEDSDOC @param newChild
- * NEEDSDOC @param oldChild
+ * @param newChild New child to replace with
+ * @param oldChild Old child to be replaced
*
- * NEEDSDOC ($objectName$) @return
+ * @return The new child
*
* @throws DOMException
*/
@@ -439,7 +439,7 @@
/**
* NodeList method: Count the immediate children of this node
*
- * @return int
+ * @return The count of children of this node
*/
public int getLength()
{
@@ -462,8 +462,8 @@
* NodeList method: Return the Nth immediate child of this node, or
* null if the index is out of bounds.
*
- * @param index
- * @return org.w3c.dom.Node
+ * @param index Index of child to find
+ * @return org.w3c.dom.Node: the child node at given index
*/
public Node item(int index)
{
@@ -484,7 +484,7 @@
/**
* Get the stylesheet owner.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The stylesheet owner
*/
public Document getOwnerDocument()
{
@@ -494,7 +494,7 @@
/**
* Return the element name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element name
*/
public String getTagName()
{
@@ -504,7 +504,7 @@
/**
* Return the base identifier.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The base identifier
*/
public String getBaseIdentifier()
{
@@ -513,7 +513,7 @@
return this.getSystemId();
}
- /** NEEDSDOC Field m_lineNumber */
+ /** line number where the current document event ends */
private int m_lineNumber;
/**
@@ -528,7 +528,7 @@
return m_lineNumber;
}
- /** NEEDSDOC Field m_columnNumber */
+ /** the column number where the current document event ends */
private int m_columnNumber;
/**
@@ -574,7 +574,7 @@
/**
* Set the location information for this element.
*
- * NEEDSDOC @param locator
+ * @param locator Source Locator with location information for this element
*/
public void setLocaterInfo(SourceLocator locator)
{
@@ -613,7 +613,7 @@
* @see <a href="http://www.w3.org/TR/xslt#strip";>strip in XSLT
Specification</a>
* @see <a
href="http://www.w3.org/TR/xslt#section-Creating-Text";>section-Creating-Text in
XSLT Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the xml:space attribute
*/
public boolean getXmlSpace()
{
@@ -630,7 +630,8 @@
* Return a table that contains all prefixes available
* within this element context.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Vector containing the prefixes available within this
+ * element context
*/
public Vector getDeclaredPrefixes()
{
@@ -1025,7 +1026,7 @@
/**
* Get the parent as a Node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's parent node
*/
public Node getParentNode()
{
@@ -1035,7 +1036,7 @@
/**
* Get the parent as an ElemTemplateElement.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's parent as an ElemTemplateElement
*/
public ElemTemplateElement getParentElem()
{
@@ -1051,7 +1052,7 @@
/**
* Get the next sibling (as a Node) or return null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return this node's next sibling or null
*/
public Node getNextSibling()
{
@@ -1065,7 +1066,7 @@
* TODO: If we were sure parents and sibs are always ElemTemplateElements,
* we could hit the fields directly rather than thru accessors.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's previous sibling or null
*/
public Node getPreviousSibling()
{
@@ -1086,7 +1087,7 @@
/**
* Get the next sibling (as a ElemTemplateElement) or return null.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's next sibling (as a ElemTemplateElement) or null
*/
public ElemTemplateElement getNextSiblingElem()
{
@@ -1102,7 +1103,7 @@
/**
* Get the first child as a Node.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's first child or null
*/
public Node getFirstChild()
{
@@ -1112,7 +1113,7 @@
/**
* Get the first child as a ElemTemplateElement.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's first child (as a ElemTemplateElement) or null
*/
public ElemTemplateElement getFirstChildElem()
{
@@ -1122,7 +1123,7 @@
/**
* Get the last child.
*
- * NEEDSDOC ($objectName$) @return
+ * @return This node's last child
*/
public Node getLastChild()
{
@@ -1138,7 +1139,7 @@
return lastChild;
}
- /** NEEDSDOC Field m_DOMBackPointer */
+ /** DOM backpointer that this element originated from. */
private Node m_DOMBackPointer;
/**
@@ -1146,7 +1147,7 @@
* DOM backpointer that this element originated from.
* For tooling use.
*
- * NEEDSDOC ($objectName$) @return
+ * @return DOM backpointer that this element originated from or null.
*/
public Node getDOMBackPointer()
{
@@ -1158,7 +1159,7 @@
* DOM backpointer that this element originated from.
* For tooling use.
*
- * NEEDSDOC @param n
+ * @param n DOM backpointer that this element originated from.
*/
public void setDOMBackPointer(Node n)
{
@@ -1171,6 +1172,7 @@
* composed stylesheet and the getUid() of this element.
* Returns a negative integer, zero, or a positive integer as this
* object is less than, equal to, or greater than the specified object.
+ *
* @param o The object to be compared to this object
* @returns a negative integer, zero, or a positive integer as this object
is
* less than, equal to, or greater than the specified object.
1.3 +5 -5
xml-xalan/java/src/org/apache/xalan/templates/ElemText.java
Index: ElemText.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemText.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ElemText.java 2000/10/30 18:49:57 1.2
+++ ElemText.java 2000/12/05 22:29:31 1.3
@@ -106,7 +106,7 @@
* or xsl:text element should be output without any escaping.
* @see <a
href="http://www.w3.org/TR/xslt#disable-output-escaping";>disable-output-escaping
in XSLT Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Boolean flag indicating whether this element should disable
escaping
*/
public void setDisableOutputEscaping(boolean v)
{
@@ -131,7 +131,7 @@
* or xsl:text element should be output without any escaping.
* @see <a
href="http://www.w3.org/TR/xslt#disable-output-escaping";>disable-output-escaping
in XSLT Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Boolean flag indicating whether this element should disable
escaping
*/
public boolean getDisableOutputEscaping()
{
@@ -153,7 +153,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
@@ -163,9 +163,9 @@
/**
* Add a child to the child list.
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to children list
*
- * NEEDSDOC ($objectName$) @return
+ * @return Child added to children list
*
* @throws DOMException
*/
1.7 +9 -7
xml-xalan/java/src/org/apache/xalan/templates/ElemTextLiteral.java
Index: ElemTextLiteral.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemTextLiteral.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ElemTextLiteral.java 2000/12/01 17:50:15 1.6
+++ ElemTextLiteral.java 2000/12/05 22:29:31 1.7
@@ -82,7 +82,8 @@
/**
* Set whether or not space should be preserved.
*
- * NEEDSDOC @param v
+ * @param v Boolean flag indicating whether
+ * or not space should be preserved
*/
public void setPreserveSpace(boolean v)
{
@@ -92,7 +93,8 @@
/**
* Get whether or not space should be preserved.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Boolean flag indicating whether
+ * or not space should be preserved
*/
public boolean getPreserveSpace()
{
@@ -107,7 +109,7 @@
/**
* Set the characters that will be output to the result tree..
*
- * NEEDSDOC @param v
+ * @param v Array of characters that will be output to the result tree
*/
public void setChars(char[] v)
{
@@ -117,7 +119,7 @@
/**
* Get the characters that will be output to the result tree..
*
- * NEEDSDOC ($objectName$) @return
+ * @return Array of characters that will be output to the result tree
*/
public char[] getChars()
{
@@ -147,7 +149,7 @@
* or xsl:text element should be output without any escaping.
* @see <a
href="http://www.w3.org/TR/xslt#disable-output-escaping";>disable-output-escaping
in XSLT Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Boolean value for "disable-output-escaping" attribute.
*/
public void setDisableOutputEscaping(boolean v)
{
@@ -172,7 +174,7 @@
* or xsl:text element should be output without any escaping.
* @see <a
href="http://www.w3.org/TR/xslt#disable-output-escaping";>disable-output-escaping
in XSLT Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Boolean value of "disable-output-escaping" attribute.
*/
public boolean getDisableOutputEscaping()
{
@@ -194,7 +196,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The element's name
*/
public String getNodeName()
{
1.9 +5 -5
xml-xalan/java/src/org/apache/xalan/templates/ElemUse.java
Index: ElemUse.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemUse.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ElemUse.java 2000/12/01 17:50:17 1.8
+++ ElemUse.java 2000/12/05 22:29:31 1.9
@@ -94,7 +94,7 @@
* sets. Each name is specified as a QName, which is expanded as
* described in [2.4 Qualified Names].
*
- * NEEDSDOC @param v
+ * @param v The value to set for the "use-attribute-sets" attribute.
*/
public void setUseAttributeSets(Vector v)
{
@@ -118,7 +118,7 @@
* sets. Each name is specified as a QName, which is expanded as
* described in [2.4 Qualified Names].
*
- * NEEDSDOC @param v
+ * @param v The value to set for the "use-attribute-sets" attribute.
*/
public void setUseAttributeSets(QName[] v)
{
@@ -136,7 +136,7 @@
* sets. Each name is specified as a QName, which is expanded as
* described in [2.4 Qualified Names].
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "use-attribute-sets" attribute.
*/
public QName[] getUseAttributeSets()
{
@@ -151,8 +151,8 @@
* set with higher import precedence that also contains the attribute."
*
* @param transformer non-null reference to the the current transform-time
state.
- * NEEDSDOC @param stylesheet
- * NEEDSDOC @param attributeSetsNames
+ * @param stylesheet The owning root stylesheet
+ * @param attributeSetsNames List of attribute sets names to apply
* @param sourceNode non-null reference to the <a
href="http://www.w3.org/TR/xslt#dt-current-node";>current source node</a>.
* @param mode reference, which may be null, to the <a
href="http://www.w3.org/TR/xslt#modes";>current mode</a>.
*
1.10 +7 -7
xml-xalan/java/src/org/apache/xalan/templates/ElemValueOf.java
Index: ElemValueOf.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemValueOf.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ElemValueOf.java 2000/12/01 17:50:17 1.9
+++ ElemValueOf.java 2000/12/05 22:29:32 1.10
@@ -97,7 +97,7 @@
* is evaluated and the resulting object is converted to a
* string as if by a call to the string function.
*
- * NEEDSDOC @param v
+ * @param v The value to set for the "select" attribute.
*/
public void setSelect(XPath v)
{
@@ -110,7 +110,7 @@
* is evaluated and the resulting object is converted to a
* string as if by a call to the string function.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "select" attribute.
*/
public XPath getSelect()
{
@@ -140,7 +140,7 @@
* or xsl:text element should be output without any escaping.
* @see <a
href="http://www.w3.org/TR/xslt#disable-output-escaping";>disable-output-escaping
in XSLT Specification</a>
*
- * NEEDSDOC @param v
+ * @param v The value to set for the "disable-output-escaping" attribute.
*/
public void setDisableOutputEscaping(boolean v)
{
@@ -165,7 +165,7 @@
* or xsl:text element should be output without any escaping.
* @see <a
href="http://www.w3.org/TR/xslt#disable-output-escaping";>disable-output-escaping
in XSLT Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return The value of the "disable-output-escaping" attribute.
*/
public boolean getDisableOutputEscaping()
{
@@ -187,7 +187,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The node name
*/
public String getNodeName()
{
@@ -253,9 +253,9 @@
/**
* Add a child to the child list.
*
- * NEEDSDOC @param newChild
+ * @param newChild Child to add to children list
*
- * NEEDSDOC ($objectName$) @return
+ * @return Child just added to children list
*
* @throws DOMException
*/
1.9 +11 -9
xml-xalan/java/src/org/apache/xalan/templates/ElemVariable.java
Index: ElemVariable.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemVariable.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ElemVariable.java 2000/12/01 17:50:17 1.8
+++ ElemVariable.java 2000/12/05 22:29:32 1.9
@@ -105,7 +105,7 @@
* evaluating the expression. In this case, the content
* of the variable must be empty.
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "select" attribute.
*/
public void setSelect(XPath v)
{
@@ -120,7 +120,7 @@
* evaluating the expression. In this case, the content
* of the variable must be empty.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "select" attribute.
*/
public XPath getSelect()
{
@@ -140,7 +140,7 @@
* as described in [2.4 Qualified Names].
* @see <a href="http://www.w3.org/TR/xslt#qname";>qname in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "name" attribute.
*/
public void setName(QName v)
{
@@ -155,7 +155,7 @@
* as described in [2.4 Qualified Names].
* @see <a href="http://www.w3.org/TR/xslt#qname";>qname in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "name" attribute.
*/
public QName getName()
{
@@ -171,7 +171,8 @@
* Set if this is a top-level variable or param, or not.
* @see <a
href="http://www.w3.org/TR/xslt#top-level-variables";>top-level-variables in
XSLT Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Boolean indicating whether this is a top-level variable
+ * or param, or not.
*/
public void setIsTopLevel(boolean v)
{
@@ -182,7 +183,8 @@
* Get if this is a top-level variable or param, or not.
* @see <a
href="http://www.w3.org/TR/xslt#top-level-variables";>top-level-variables in
XSLT Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Boolean indicating whether this is a top-level variable
+ * or param, or not.
*/
public boolean getIsTopLevel()
{
@@ -204,7 +206,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The node name
*/
public String getNodeName()
{
@@ -214,7 +216,7 @@
/**
* Copy constructor.
*
- * NEEDSDOC @param param
+ * @param param An element created from an xsl:variable
*
* @throws TransformerException
*/
@@ -258,7 +260,7 @@
* @param transformer non-null reference to the the current transform-time
state.
* @param sourceNode non-null reference to the <a
href="http://www.w3.org/TR/xslt#dt-current-node";>current source node</a>.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the XObject representation of the variable.
*
* @throws TransformerException
*/
1.4 +3 -3
xml-xalan/java/src/org/apache/xalan/templates/ElemWhen.java
Index: ElemWhen.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemWhen.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ElemWhen.java 2000/10/30 18:50:01 1.3
+++ ElemWhen.java 2000/12/05 22:29:32 1.4
@@ -90,7 +90,7 @@
* Each xsl:when element has a single attribute, test,
* which specifies an expression.
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "test" attribute.
*/
public void setTest(XPath v)
{
@@ -102,7 +102,7 @@
* Each xsl:when element has a single attribute, test,
* which specifies an expression.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "test" attribute.
*/
public XPath getTest()
{
@@ -124,7 +124,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The node name
*/
public String getNodeName()
{
1.5 +5 -5
xml-xalan/java/src/org/apache/xalan/templates/ElemWithParam.java
Index: ElemWithParam.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemWithParam.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ElemWithParam.java 2000/11/23 04:57:55 1.4
+++ ElemWithParam.java 2000/12/05 22:29:33 1.5
@@ -92,7 +92,7 @@
* The "select" attribute specifies the value of the
* argument, if element content is not specified.
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "select" attribute.
*/
public void setSelect(XPath v)
{
@@ -104,7 +104,7 @@
* The "select" attribute specifies the value of the
* argument, if element content is not specified.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "select" attribute.
*/
public XPath getSelect()
{
@@ -123,7 +123,7 @@
* Set the "name" attribute.
* DJD
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "name" attribute.
*/
public void setName(QName v)
{
@@ -134,7 +134,7 @@
* Get the "name" attribute.
* DJD
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "name" attribute.
*/
public QName getName()
{
@@ -156,7 +156,7 @@
/**
* Return the node name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the node name.
*/
public String getNodeName()
{
1.16 +15 -18
xml-xalan/java/src/org/apache/xalan/templates/FuncDocument.java
Index: FuncDocument.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/FuncDocument.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- FuncDocument.java 2000/11/23 04:57:55 1.15
+++ FuncDocument.java 2000/12/05 22:29:33 1.16
@@ -234,14 +234,15 @@
}
/**
- * HandleDocExpr
+ * Get the document from the given URI and base
*
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param context
- * NEEDSDOC @param uri
- * NEEDSDOC @param base
+ * @param xctxt The XPath runtime state.
+ * @param context The current context node
+ * @param uri Relative(?) URI of the document
+ * @param base Base to resolve relative URI from.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The document Node pointing to the document at the given URI
+ * or null
*
* @throws javax.xml.transform.TransformerException
*/
@@ -387,9 +388,9 @@
* Tell the user of an error, and probably throw an
* exception.
*
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param xctxt The XPath runtime state.
+ * @param msg The error message code
+ * @param args Arguments to be used in the error message
* @exception XSLProcessorException thrown if the active ProblemListener
and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -413,9 +414,9 @@
/**
* Warn the user of a problem.
*
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param xctxt The XPath runtime state.
+ * @param msg Warning message code
+ * @param args Arguments to be used in the warning message
* @exception XSLProcessorException thrown if the active ProblemListener
and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -436,15 +437,11 @@
System.out.println(formattedMsg);
}
- /*
+ /**
* Overide the superclass method to allow one or two arguments.
- */
-
- /**
- * NEEDSDOC Method checkNumberArgs
*
*
- * NEEDSDOC @param argNum
+ * @param argNum Number of arguments passed in to this function
*
* @throws WrongNumberArgsException
*/
1.12 +5 -5
xml-xalan/java/src/org/apache/xalan/templates/FuncFormatNumb.java
Index: FuncFormatNumb.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/FuncFormatNumb.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- FuncFormatNumb.java 2000/11/30 09:57:32 1.11
+++ FuncFormatNumb.java 2000/12/05 22:29:33 1.12
@@ -185,9 +185,9 @@
/**
* Warn the user of a problem.
*
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param xctxt The XPath runtime state.
+ * @param msg Warning message code
+ * @param args Arguments to be used in warning message
* @exception XSLProcessorException thrown if the active ProblemListener
and XPathContext decide
* the error condition is severe enough to halt processing.
*
@@ -205,10 +205,10 @@
}
/**
- * NEEDSDOC Method checkNumberArgs
+ * Overide the superclass method to allow one or two arguments.
*
*
- * NEEDSDOC @param argNum
+ * @param argNum Number of arguments passed in
*
* @throws WrongNumberArgsException
*/
1.7 +1 -1
xml-xalan/java/src/org/apache/xalan/templates/FuncKey.java
Index: FuncKey.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/FuncKey.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- FuncKey.java 2000/11/23 04:57:56 1.6
+++ FuncKey.java 2000/12/05 22:29:34 1.7
@@ -86,7 +86,7 @@
public class FuncKey extends Function2Args
{
- /** NEEDSDOC Field ISTRUE */
+ /** Dummy value to be used in usedrefs hashtable */
static private Boolean ISTRUE = new Boolean(true);
/**
1.6 +10 -10
xml-xalan/java/src/org/apache/xalan/templates/KeyDeclaration.java
Index: KeyDeclaration.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/KeyDeclaration.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- KeyDeclaration.java 2000/11/30 09:57:32 1.5
+++ KeyDeclaration.java 2000/12/05 22:29:34 1.6
@@ -94,7 +94,7 @@
* of the name attribute is a QName, which is expanded as
* described in [2.4 Qualified Names].
*
- * NEEDSDOC @param name
+ * @param name Value to set for the "name" attribute.
*/
public void setName(QName name)
{
@@ -107,7 +107,7 @@
* of the name attribute is a QName, which is expanded as
* described in [2.4 Qualified Names].
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "name" attribute.
*/
public QName getName()
{
@@ -126,7 +126,7 @@
* pattern specified in the match attribute.
* @see <a href="http://www.w3.org/TR/xslt#patterns";>patterns in XSLT
Specification</a>
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "match" attribute.
*/
public void setMatch(XPath v)
{
@@ -140,7 +140,7 @@
* pattern specified in the match attribute.
* @see <a href="http://www.w3.org/TR/xslt#patterns";>patterns in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "match" attribute.
*/
public XPath getMatch()
{
@@ -158,7 +158,7 @@
* of the key; the expression is evaluated once for each node
* that matches the pattern.
*
- * NEEDSDOC @param v
+ * @param v Value to set for the "use" attribute.
*/
public void setUse(XPath v)
{
@@ -171,23 +171,23 @@
* of the key; the expression is evaluated once for each node
* that matches the pattern.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Value of the "use" attribute.
*/
public XPath getUse()
{
return m_use;
}
- /** NEEDSDOC Field UNBUILT */
+ /** Constant for build state of this key */
public static int UNBUILT = -1;
- /** NEEDSDOC Field BUILDING */
+ /** Constant for build state of this key */
public static int BUILDING = 0;
- /** NEEDSDOC Field BUILT */
+ /** Constant for build state of this key */
public static int BUILT = 1;
- /** NEEDSDOC Field m_buildState */
+ /** Hold the build state of this key */
private int m_buildState = UNBUILT;
/**
1.14 +51 -49
xml-xalan/java/src/org/apache/xalan/templates/OutputFormatExtended.java
Index: OutputFormatExtended.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/OutputFormatExtended.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- OutputFormatExtended.java 2000/11/30 09:57:32 1.13
+++ OutputFormatExtended.java 2000/12/05 22:29:34 1.14
@@ -75,160 +75,158 @@
implements java.io.Serializable, RecomposableBase
{
- // Flag to tell us when to record that an attribute
- // has been set.
-
- /** NEEDSDOC Field m_shouldRecordHasBeenSet */
+ /** Flag to tell us when to record that an attribute
+ * has been set. */
private boolean m_shouldRecordHasBeenSet;
- /** NEEDSDOC Field m_methodHasBeenSet */
+ /** Flag to tell us that a method has been set */
private boolean m_methodHasBeenSet = false;
/**
- * NEEDSDOC Method methodHasBeenSet
+ * Return local flag to tell us that a method has been set
*
*
- * NEEDSDOC (methodHasBeenSet) @return
+ * @return Flag to tell us that a method has been set
*/
public boolean methodHasBeenSet()
{
return m_methodHasBeenSet;
}
- /** NEEDSDOC Field m_versionHasBeenSet */
+ /** Flag to tell us that a version has been set */
private boolean m_versionHasBeenSet = false;
/**
- * NEEDSDOC Method versionHasBeenSet
+ * Return local flag to tell us that a version has been set
*
*
- * NEEDSDOC (versionHasBeenSet) @return
+ * @return Flag to tell us that a version has been set
*/
public boolean versionHasBeenSet()
{
return m_versionHasBeenSet;
}
- /** NEEDSDOC Field m_indentHasBeenSet */
+ /** Flag to tell us that an indent value has been set */
private boolean m_indentHasBeenSet = false;
/**
- * NEEDSDOC Method indentHasBeenSet
+ * Return local flag to tell us that an indent value has been set
*
*
- * NEEDSDOC (indentHasBeenSet) @return
+ * @return Flag to tell us that an indent value has been set
*/
public boolean indentHasBeenSet()
{
return m_indentHasBeenSet;
}
- /** NEEDSDOC Field m_encodingHasBeenSet */
+ /** Flag to tell us that an encoding has been set */
private boolean m_encodingHasBeenSet = false;
/**
- * NEEDSDOC Method encodingHasBeenSet
+ * Return local flag to tell us that an encoding has been set
*
*
- * NEEDSDOC (encodingHasBeenSet) @return
+ * @return Flag to tell us that an encoding has been set
*/
public boolean encodingHasBeenSet()
{
return m_encodingHasBeenSet;
}
- /** NEEDSDOC Field m_mediaTypeHasBeenSet */
+ /** Flag to tell us that a media type has been set */
private boolean m_mediaTypeHasBeenSet;
/**
- * NEEDSDOC Method mediaTypeHasBeenSet
+ * Return local flag to tell us that a media type has been set
*
*
- * NEEDSDOC (mediaTypeHasBeenSet) @return
+ * @return Flag to tell us that a media type has been set
*/
public boolean mediaTypeHasBeenSet()
{
return m_mediaTypeHasBeenSet;
}
- /** NEEDSDOC Field m_doctypeSystemHasBeenSet */
+ /** Flag to tell us that a doctypesystem has been set */
private boolean m_doctypeSystemHasBeenSet;
/**
- * NEEDSDOC Method doctypeSystemHasBeenSet
+ * Return local flag to tell us that a doctypesystem has been set
*
*
- * NEEDSDOC (doctypeSystemHasBeenSet) @return
+ * @return Flag to tell us that a doctypesystem has been set
*/
public boolean doctypeSystemHasBeenSet()
{
return m_doctypeSystemHasBeenSet;
}
- /** NEEDSDOC Field m_doctypePublicHasBeenSet */
+ /** Flag to tell us that a doctypepublic has been set */
private boolean m_doctypePublicHasBeenSet;
/**
- * NEEDSDOC Method doctypePublicHasBeenSet
+ * Return local flag to tell us that a doctypepublic has been set
*
*
- * NEEDSDOC (doctypePublicHasBeenSet) @return
+ * @return Flag to tell us that a doctypepublic has been set
*/
public boolean doctypePublicHasBeenSet()
{
return m_doctypePublicHasBeenSet;
}
- /** NEEDSDOC Field m_omitXmlDeclarationHasBeenSet */
+ /** Flag to tell us that omitXMLDeclaration has been set */
private boolean m_omitXmlDeclarationHasBeenSet = false;
/**
- * NEEDSDOC Method omitXmlDeclarationHasBeenSet
+ * Return local flag to tell us that omitXMLDeclaration has been set
*
*
- * NEEDSDOC (omitXmlDeclarationHasBeenSet) @return
+ * @return Flag to tell us that omitXMLDeclaration has been set
*/
public boolean omitXmlDeclarationHasBeenSet()
{
return m_omitXmlDeclarationHasBeenSet;
}
- /** NEEDSDOC Field m_standaloneHasBeenSet */
+ /** Flag to tell us that standalone has been set */
private boolean m_standaloneHasBeenSet = false;
/**
- * NEEDSDOC Method standaloneHasBeenSet
+ * Return local flag to tell us that standalone has been set
*
*
- * NEEDSDOC (standaloneHasBeenSet) @return
+ * @return Flag to tell us that standalone has been set
*/
public boolean standaloneHasBeenSet()
{
return m_standaloneHasBeenSet;
}
- /** NEEDSDOC Field m_cdataElementsHasBeenSet */
+ /** Flag to tell us that cdataElements has been set */
private boolean m_cdataElementsHasBeenSet = false;
/**
- * NEEDSDOC Method cdataElementsHasBeenSet
+ * Return local flag to tell us that cdataElements has been set
*
*
- * NEEDSDOC (cdataElementsHasBeenSet) @return
+ * @return Flag to tell us that cdataElements has been set
*/
public boolean cdataElementsHasBeenSet()
{
return m_cdataElementsHasBeenSet;
}
- /** NEEDSDOC Field m_nonEscapingElementsHasBeenSet */
+ /** Flag to tell us that nonEscapingElements has been set */
private boolean m_nonEscapingElementsHasBeenSet = false;
/**
- * NEEDSDOC Method nonEscapingElementsHasBeenSet
+ * Return local flag to tell us that nonEscapingElements has been set
*
*
- * NEEDSDOC (nonEscapingElementsHasBeenSet) @return
+ * @return Flag to tell us that nonEscapingElements has been set
*/
public boolean nonEscapingElementsHasBeenSet()
{
@@ -237,6 +235,8 @@
/**
* Constructs a new output format with the default values.
+ *
+ * @param docOrderNumber The Document Order
*/
public OutputFormatExtended(int docOrderNumber)
{
@@ -266,10 +266,10 @@
}
/**
- * NEEDSDOC Method copyFrom
+ * Create a copy of a given OutputFormatExtended object
*
*
- * NEEDSDOC @param of
+ * @param of OutputFormatExtended object to copy from
*/
void copyFrom(OutputFormatExtended of)
{
@@ -341,10 +341,10 @@
}
/**
- * NEEDSDOC Method copyFrom
+ * Create a OutputFormatExtended from an OutputFormat object
*
*
- * NEEDSDOC @param of
+ * @param of OutputFormat object to copy from
*/
void copyFrom(OutputFormat of)
{
@@ -374,7 +374,7 @@
/**
* The doctype-public attribute.
*
- * NEEDSDOC @param publicId
+ * @param publicId value of doctype-public attribute.
*/
public void setDoctypePublic(String publicId)
{
@@ -390,7 +390,7 @@
/**
* The doctype-system attribute.
*
- * NEEDSDOC @param systemId
+ * @param systemId value of doctype-system attribute.
*/
public void setDoctypeSystem(String systemId)
{
@@ -405,7 +405,8 @@
/**
* The omit-xml-declaration attribute.
*
- * NEEDSDOC @param omit
+ * @param omit value of omit-xml-declaration attribute: true if
+ * xml declaration should be omitted.
*/
public void setOmitXmlDeclaration(boolean omit)
{
@@ -419,8 +420,9 @@
/**
* The cdata-section-elements attribute.
*
- * NEEDSDOC @param elements
- */
+ * @param elements value of cdata-section-elements attribute (a
+ * vector of CDATA names).
+ */
public void setCdataSectionElements(Vector elements)
{
@@ -441,7 +443,8 @@
/**
* The cdata-section-elements attribute.
*
- * NEEDSDOC @param elements
+ * @param elements value of cdata-section-elements attribute (an
+ * array of CDATA names).
*/
public void setCdataSectionElements(org.apache.xml.utils.QName[] elements)
{
@@ -548,9 +551,8 @@
* the [EMAIL PROTECTED] org.apache.xalan.processor.XSLTSchema
* XSLTSchema} class.</p>
*
- * @param on True if indentation should be on
+ * @param indent True if indentation should be on
*
- * NEEDSDOC @param indent
*/
public void setIndent(boolean indent)
{
1.2 +1 -1
xml-xalan/java/src/org/apache/xalan/templates/Recomposable.java
Index: Recomposable.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/Recomposable.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Recomposable.java 2000/11/30 09:57:32 1.1
+++ Recomposable.java 2000/12/05 22:29:34 1.2
@@ -59,7 +59,7 @@
/**
* This interface defines a recomposable stylesheet element. The interface
requires
* the compareTo() method.
- * When we migrate to Java2, ththe compareTo method should be removed this
interface
+ * When we migrate to Java2, the compareTo method should be removed this
interface
* should also extend java.lang.Comparable.
*/
1.3 +2 -0
xml-xalan/java/src/org/apache/xalan/templates/RecomposableBase.java
Index: RecomposableBase.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/RecomposableBase.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RecomposableBase.java 2000/12/04 22:45:38 1.2
+++ RecomposableBase.java 2000/12/05 22:29:35 1.3
@@ -67,6 +67,8 @@
/**
* Recomposes this object with others of its type.
+ *
+ * @param root The owning root stylesheet
*/
public void recompose(StylesheetRoot root) throws TransformerException;
}
1.3 +14 -1
xml-xalan/java/src/org/apache/xalan/templates/RecomposableImpl.java
Index: RecomposableImpl.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/RecomposableImpl.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RecomposableImpl.java 2000/12/04 22:45:38 1.2
+++ RecomposableImpl.java 2000/12/05 22:29:35 1.3
@@ -72,7 +72,7 @@
private StylesheetComposed m_owningStylesheet;
/**
- * The document order in which which object was encountered.
+ * The document order in which object was encountered.
*/
private int m_docOrderNumber;
@@ -81,6 +81,13 @@
*/
private RecomposableBase m_obj;
+ /**
+ * Constructor
+ *
+ * @param owningStylesheet Owning composed stylesheet for this object
+ * @parm uid The document order for this object
+ * @parm o The underlying object for the recomposition.
+ */
RecomposableImpl(StylesheetComposed owningStylesheet, int uid,
RecomposableBase o)
{
m_owningStylesheet = owningStylesheet;
@@ -90,6 +97,8 @@
/**
* Returns the composed stylesheet to which this recomposable element
belongs.
+ *
+ * @return The composed stylesheet with which this object is associated.
*/
public StylesheetComposed getStylesheetComposed()
{
@@ -98,6 +107,8 @@
/**
* Returns the relative document order for this recomposable element.
+ *
+ * @return the relative document order for this recomposable element.
*/
public int getUid()
{
@@ -132,6 +143,8 @@
/**
* Recomposes this object with others of its type.
+ *
+ * @parm root The owning root stylesheet for this object
*/
public void recompose(StylesheetRoot root) throws TransformerException
{
1.22 +11 -10
xml-xalan/java/src/org/apache/xalan/templates/StylesheetComposed.java
Index: StylesheetComposed.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/StylesheetComposed.java,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- StylesheetComposed.java 2000/12/03 19:27:25 1.21
+++ StylesheetComposed.java 2000/12/05 22:29:35 1.22
@@ -110,7 +110,7 @@
* Tell if this can be cast to a StylesheetComposed, meaning, you
* can ask questions from getXXXComposed functions.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True since this is a StylesheetComposed
*/
public boolean isAggregatedType()
{
@@ -217,7 +217,7 @@
}
}
- /** NEEDSDOC Field m_importNumber */
+ /** Order in import chain */
private int m_importNumber = -1;
/** The precedence of this stylesheet in the global import list.
@@ -246,9 +246,9 @@
* Get a stylesheet from the "import" list.
* @see <a href="http://www.w3.org/TR/xslt#import";>import in XSLT
Specification</a>
*
- * NEEDSDOC @param i
+ * @param i Index of stylesheet in import list
*
- * NEEDSDOC ($objectName$) @return
+ * @return The stylesheet at the given index
*
* @throws ArrayIndexOutOfBoundsException
*/
@@ -270,7 +270,7 @@
* The lowest precedence is 0. A higher number has a higher precedence.
* @see <a href="http://www.w3.org/TR/xslt#import";>import in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return the precedence of this stylesheet in the global import list.
*/
public int getImportCountComposed()
{
@@ -286,7 +286,7 @@
* Recompose the value of the composed include list. Builds a composite
* list of all stylesheets included by this stylesheet to any depth.
*
- * @param including
+ * @param including Stylesheet to recompose
*/
void recomposeIncludes(Stylesheet including)
{
@@ -311,9 +311,9 @@
* Get an "xsl:include" property.
* @see <a href="http://www.w3.org/TR/xslt#include";>include in XSLT
Specification</a>
*
- * NEEDSDOC @param i
+ * @param i Index of stylesheet in "include" list
*
- * NEEDSDOC ($objectName$) @return
+ * @return The stylesheet at the given index in the "include" list
*
* @throws ArrayIndexOutOfBoundsException
*/
@@ -334,7 +334,7 @@
* Get the number of included stylesheets.
* @see <a href="http://www.w3.org/TR/xslt#import";>import in XSLT
Specification</a>
*
- * NEEDSDOC ($objectName$) @return
+ * @return the number of included stylesheets.
*/
public int getIncludeCountComposed()
{
@@ -351,7 +351,8 @@
* NOTE: GLP 29-Nov-00 I've left this method in so that
CompilingStylesheetHandler will compile. However,
* I'm not sure why it's needed or what it does and
I've commented out the body.
*
- * NEEDSDOC @param flushFirst
+ * @param flushFirst Flag indicating the option of overwriting
+ * (rather than appending to) previous composition.
*
* @throws TransformerException
*/
