You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by mm...@locus.apache.org on 2000/12/13 22:56:21 UTC
cvs commit: xml-xalan/java/src/org/apache/xalan/templates DecimalFormatProperties.java TemplateList.java TemplateSubPatternAssociation.java WhiteSpaceInfo.java
mmidy 00/12/13 13:56:21
Modified: java/src/org/apache/xalan/templates
DecimalFormatProperties.java TemplateList.java
TemplateSubPatternAssociation.java
WhiteSpaceInfo.java
Log:
Javadoc updates
Revision Changes Path
1.9 +26 -24 xml-xalan/java/src/org/apache/xalan/templates/DecimalFormatProperties.java
Index: DecimalFormatProperties.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/templates/DecimalFormatProperties.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- DecimalFormatProperties.java 2000/12/03 19:27:25 1.8
+++ DecimalFormatProperties.java 2000/12/13 21:56:19 1.9
@@ -96,7 +96,7 @@
public class DecimalFormatProperties extends ElemTemplateElement
{
- /** NEEDSDOC Field m_dfs */
+ /** An instance of DecimalFormatSymbols for this element */
DecimalFormatSymbols m_dfs;
/**
@@ -132,7 +132,7 @@
* method pair there is an attribute defined for the xsl:decimal-format
* element.</p>
*
- * NEEDSDOC ($objectName$) @return
+ * @return the decimal format Symbols for this element.
*/
public DecimalFormatSymbols getDecimalFormatSymbols()
{
@@ -150,7 +150,7 @@
* If there is a name attribute, then the element declares a named
* decimal-format; otherwise, it declares the default decimal-format.
*
- * NEEDSDOC @param qname
+ * @param qname The name to set as the "name" attribute.
*/
public void setName(QName qname)
{
@@ -162,7 +162,7 @@
* If there is a name attribute, then the element declares a named
* decimal-format; otherwise, it declares the default decimal-format.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the value of the "name" attribute.
*/
public QName getName()
{
@@ -178,7 +178,7 @@
* decimal-separator specifies the character used for the decimal sign;
* the default value is the period character (.).
*
- * NEEDSDOC @param ds
+ * @param ds Character to set as decimal separator
*/
public void setDecimalSeparator(char ds)
{
@@ -190,7 +190,7 @@
* decimal-separator specifies the character used for the decimal sign;
* the default value is the period character (.).
*
- * NEEDSDOC ($objectName$) @return
+ * @return the character to use as decimal separator
*/
public char getDecimalSeparator()
{
@@ -202,7 +202,7 @@
* grouping-separator specifies the character used as a grouping
* (e.g. thousands) separator; the default value is the comma character (,).
*
- * NEEDSDOC @param gs
+ * @param gs Character to use a grouping separator
*/
public void setGroupingSeparator(char gs)
{
@@ -214,7 +214,7 @@
* grouping-separator specifies the character used as a grouping
* (e.g. thousands) separator; the default value is the comma character (,).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Character to use a grouping separator
*/
public char getGroupingSeparator()
{
@@ -226,7 +226,7 @@
* infinity specifies the string used to represent infinity;
* the default value is the string Infinity.
*
- * NEEDSDOC @param inf
+ * @param inf String to use as the "infinity" attribute.
*/
public void setInfinity(String inf)
{
@@ -238,7 +238,7 @@
* infinity specifies the string used to represent infinity;
* the default value is the string Infinity.
*
- * NEEDSDOC ($objectName$) @return
+ * @return String to use as the "infinity" attribute.
*/
public String getInfinity()
{
@@ -250,7 +250,7 @@
* minus-sign specifies the character used as the default minus sign; the
* default value is the hyphen-minus character (-, #x2D).
*
- * NEEDSDOC @param v
+ * @param v Character to use as minus sign
*/
public void setMinusSign(char v)
{
@@ -262,7 +262,7 @@
* minus-sign specifies the character used as the default minus sign; the
* default value is the hyphen-minus character (-, #x2D).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Character to use as minus sign
*/
public char getMinusSign()
{
@@ -274,7 +274,7 @@
* NaN specifies the string used to represent the NaN value;
* the default value is the string NaN.
*
- * NEEDSDOC @param v
+ * @param v String to use as the "NaN" attribute.
*/
public void setNaN(String v)
{
@@ -286,7 +286,7 @@
* NaN specifies the string used to represent the NaN value;
* the default value is the string NaN.
*
- * NEEDSDOC ($objectName$) @return
+ * @return String to use as the "NaN" attribute.
*/
public String getNaN()
{
@@ -298,7 +298,7 @@
* percent specifies the character used as a percent sign; the default
* value is the percent character (%).
*
- * NEEDSDOC @param v
+ * @param v Character to use as percent
*/
public void setPercent(char v)
{
@@ -310,7 +310,7 @@
* percent specifies the character used as a percent sign; the default
* value is the percent character (%).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Character to use as percent
*/
public char getPercent()
{
@@ -322,7 +322,7 @@
* per-mille specifies the character used as a per mille sign; the default
* value is the Unicode per-mille character (#x2030).
*
- * NEEDSDOC @param v
+ * @param v Character to use as per-mille
*/
public void setPerMille(char v)
{
@@ -334,7 +334,7 @@
* per-mille specifies the character used as a per mille sign; the default
* value is the Unicode per-mille character (#x2030).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Character to use as per-mille
*/
public char getPerMille()
{
@@ -346,7 +346,7 @@
* zero-digit specifies the character used as the digit zero; the default
* value is the digit zero (0).
*
- * NEEDSDOC @param v
+ * @param v Character to use as the digit zero
*/
public void setZeroDigit(char v)
{
@@ -358,7 +358,7 @@
* zero-digit specifies the character used as the digit zero; the default
* value is the digit zero (0).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Character to use as the digit zero
*/
public char getZeroDigit()
{
@@ -370,7 +370,7 @@
* digit specifies the character used for a digit in the format pattern;
* the default value is the number sign character (#).
*
- * NEEDSDOC @param v
+ * @param v Character to use for a digit in format pattern
*/
public void setDigit(char v)
{
@@ -382,7 +382,7 @@
* digit specifies the character used for a digit in the format pattern;
* the default value is the number sign character (#).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Character to use for a digit in format pattern
*/
public char getDigit()
{
@@ -395,7 +395,7 @@
* and negative sub patterns in a pattern; the default value is the
* semi-colon character (;).
*
- * NEEDSDOC @param v
+ * @param v Character to use as a pattern separator
*/
public void setPatternSeparator(char v)
{
@@ -408,7 +408,7 @@
* and negative sub patterns in a pattern; the default value is the
* semi-colon character (;).
*
- * NEEDSDOC ($objectName$) @return
+ * @return Character to use as a pattern separator
*/
public char getPatternSeparator()
{
@@ -417,6 +417,8 @@
/**
* This function is called to recompose() all of the decimal format properties elements.
+ *
+ * @param root Stylesheet root
*/
public void recompose(StylesheetRoot root)
{
1.29 +9 -9 xml-xalan/java/src/org/apache/xalan/templates/TemplateList.java
Index: TemplateList.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/templates/TemplateList.java,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- TemplateList.java 2000/12/13 16:00:44 1.28
+++ TemplateList.java 2000/12/13 21:56:19 1.29
@@ -154,11 +154,11 @@
}
}
- /** NEEDSDOC Field DEBUG */
+ /** Flag to indicate whether in DEBUG mode */
boolean DEBUG = false;
/**
- * NEEDSDOC Method dumpAssociationTables
+ * Dump all patterns and elements that match those patterns
*
*/
void dumpAssociationTables()
@@ -574,9 +574,9 @@
/**
* Check for match conflicts, and warn the stylesheet author.
*
- * NEEDSDOC @param head
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param targetNode
+ * @param head Template pattern
+ * @param xctxt Current XPath context
+ * @param targetNode Node matching the pattern
* @param mode reference, which may be null, to the <a href="http://www.w3.org/TR/xslt#modes">current mode</a>.
*/
private void checkConflicts(TemplateSubPatternAssociation head,
@@ -632,16 +632,16 @@
*/
private Hashtable m_patternTable = new Hashtable(89);
- /** NEEDSDOC Field m_wildCardPatterns */
+ /** Wildcard patterns */
private TemplateSubPatternAssociation m_wildCardPatterns = null;
- /** NEEDSDOC Field m_textPatterns */
+ /** Text Patterns */
private TemplateSubPatternAssociation m_textPatterns = null;
- /** NEEDSDOC Field m_docPatterns */
+ /** Root document Patterns */
private TemplateSubPatternAssociation m_docPatterns = null;
- /** NEEDSDOC Field m_commentPatterns */
+ /** Comment Patterns */
private TemplateSubPatternAssociation m_commentPatterns = null;
/**
1.9 +16 -16 xml-xalan/java/src/org/apache/xalan/templates/TemplateSubPatternAssociation.java
Index: TemplateSubPatternAssociation.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/templates/TemplateSubPatternAssociation.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- TemplateSubPatternAssociation.java 2000/12/01 17:50:18 1.8
+++ TemplateSubPatternAssociation.java 2000/12/13 21:56:20 1.9
@@ -74,22 +74,22 @@
class TemplateSubPatternAssociation implements Serializable, Cloneable
{
- /** NEEDSDOC Field m_stepPattern */
+ /** Step pattern */
StepPattern m_stepPattern;
- /** NEEDSDOC Field m_pattern */
+ /** Template pattern */
private String m_pattern;
- /** NEEDSDOC Field m_template */
+ /** The template element */
private ElemTemplate m_template;
- /** NEEDSDOC Field m_next */
+ /** Next pattern */
private TemplateSubPatternAssociation m_next = null;
- /** NEEDSDOC Field m_wild */
+ /** Flag indicating whether this is wild card pattern */
private boolean m_wild;
- /** NEEDSDOC Field m_targetString */
+ /** Target string for this match pattern */
private String m_targetString;
/**
@@ -111,7 +111,7 @@
/**
* Clone this object.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The cloned object.
*
* @throws CloneNotSupportedException
*/
@@ -138,10 +138,10 @@
}
/**
- * NEEDSDOC Method setTargetString
+ * Set Target String for this template pattern
*
*
- * NEEDSDOC @param key
+ * @param key Target string to set
*/
public void setTargetString(String key)
{
@@ -151,9 +151,9 @@
/**
* Tell if two modes match according to the rules of XSLT.
*
- * NEEDSDOC @param m1
+ * @param m1 mode to match
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the given mode matches this template's mode
*/
boolean matchMode(QName m1)
{
@@ -163,10 +163,10 @@
/**
* Tell if two modes match according to the rules of XSLT.
*
- * NEEDSDOC @param m1
- * NEEDSDOC @param m2
+ * @param m1 First mode to match
+ * @param m2 Second mode to match
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if the two given modes match
*/
private boolean matchModes(QName m1, QName m2)
{
@@ -178,8 +178,8 @@
* Return the mode associated with the template.
*
*
- * NEEDSDOC @param xctxt
- * NEEDSDOC @param targetNode
+ * @param xctxt XPath context to use with this template
+ * @param targetNode Target node
* @param mode reference, which may be null, to the <a href="http://www.w3.org/TR/xslt#modes">current mode</a>.
* @return The mode associated with the template.
*
1.6 +6 -4 xml-xalan/java/src/org/apache/xalan/templates/WhiteSpaceInfo.java
Index: WhiteSpaceInfo.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xalan/templates/WhiteSpaceInfo.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- WhiteSpaceInfo.java 2000/11/30 09:57:33 1.5
+++ WhiteSpaceInfo.java 2000/12/13 21:56:20 1.6
@@ -66,7 +66,7 @@
public class WhiteSpaceInfo extends ElemTemplate
{
- /** NEEDSDOC Field m_shouldStripSpace */
+ /** Flag indicating whether whitespaces should be stripped */
private boolean m_shouldStripSpace;
/**
@@ -74,7 +74,7 @@
* matches the match pattern should be stripped, otherwise
* the space should be preserved.
*
- * NEEDSDOC ($objectName$) @return
+ * @return value of m_shouldStripSpace flag
*/
public boolean getShouldStripSpace()
{
@@ -85,8 +85,10 @@
* Constructor WhiteSpaceInfo
*
*
- * NEEDSDOC @param matchPattern
- * NEEDSDOC @param shouldStripSpace
+ * @param matchPattern Match pattern
+ * @param shouldStripSpace Flag indicating whether or not
+ * to strip whitespaces
+ * @param thisSheet The current stylesheet
*/
public WhiteSpaceInfo(XPath matchPattern, boolean shouldStripSpace, Stylesheet thisSheet)
{