mmidy 00/12/13 09:23:14
Modified: java/src/org/apache/xalan/transformer QueuedSAXEvent.java
QueuedStartDocument.java QueuedStartElement.java
ResultNameSpace.java ResultTreeHandler.java
SerializerSwitcher.java StackGuard.java
TransformState.java TransformerClient.java
TreeWalker2Result.java
XSLInfiniteLoopException.java
Log:
Javadoc updates
Revision Changes Path
1.5 +26 -26
xml-xalan/java/src/org/apache/xalan/transformer/QueuedSAXEvent.java
Index: QueuedSAXEvent.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/QueuedSAXEvent.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- QueuedSAXEvent.java 2000/11/13 16:27:19 1.4
+++ QueuedSAXEvent.java 2000/12/13 17:22:58 1.5
@@ -73,42 +73,42 @@
* Constructor QueuedSAXEvent
*
*
- * NEEDSDOC @param type
+ * @param type Type of SAX event
*/
public QueuedSAXEvent(int type)
{
m_type = type;
}
- /** NEEDSDOC Field DOC */
+ /** Document SAX event */
static final int DOC = 1;
- /** NEEDSDOC Field ELEM */
+ /** Element SAX event */
static final int ELEM = 2;
- /** NEEDSDOC Field m_traceManager */
+ /** Instance of TraceManager */
protected TraceManager m_traceManager;
- /** NEEDSDOC Field m_transformer */
+ /** Instance of Transformer */
protected TransformerImpl m_transformer;
- /** NEEDSDOC Field m_contentHandler */
+ /** Instance of ContentHandler */
protected ContentHandler m_contentHandler;
- /** NEEDSDOC Field isPending */
+ /** Flag indicating that an event is pending */
public boolean isPending = false;
- /** NEEDSDOC Field isEnded */
+ /** Flag indicating that an event is ended */
public boolean isEnded = false;
- /** NEEDSDOC Field m_type */
+ /** Type of SAX event */
private int m_type;
/**
- * NEEDSDOC Method getType
+ * Get the type of this SAX event
*
*
- * NEEDSDOC (getType) @return
+ * @return The type of this SAX event
*/
int getType()
{
@@ -116,10 +116,10 @@
}
/**
- * NEEDSDOC Method setTraceManager
+ * Set the Trace Manager
*
*
- * NEEDSDOC @param traceManager
+ * @param traceManager Trace Manager to set
*/
void setTraceManager(TraceManager traceManager)
{
@@ -127,10 +127,10 @@
}
/**
- * NEEDSDOC Method setTransformer
+ * Set the Transformer
*
*
- * NEEDSDOC @param transformer
+ * @param transformer Transformer to set
*/
void setTransformer(TransformerImpl transformer)
{
@@ -138,12 +138,12 @@
}
/**
- * NEEDSDOC Method fireGenerateEvent
+ * Fire a Generate Event
*
*
- * NEEDSDOC @param type
- * NEEDSDOC @param name
- * NEEDSDOC @param attrs
+ * @param type Event type
+ * @param name Element name
+ * @param attrs Attributes for the element
*/
protected void fireGenerateEvent(int type, String name, Attributes attrs)
{
@@ -155,10 +155,10 @@
}
/**
- * NEEDSDOC Method getContentHandler
+ * Get the ContentHandler used by this event
*
*
- * NEEDSDOC (getContentHandler) @return
+ * @return The content Handler
*/
ContentHandler getContentHandler()
{
@@ -166,10 +166,10 @@
}
/**
- * NEEDSDOC Method setContentHandler
+ * Set the ContentHandler this event will use
*
*
- * NEEDSDOC @param ch
+ * @param ch Content Handler to set
*/
void setContentHandler(ContentHandler ch)
{
@@ -185,10 +185,10 @@
}
/**
- * NEEDSDOC Method setPending
+ * Set whether this event is pending
*
*
- * NEEDSDOC @param b
+ * @param b Flag indicating whether this event is pending
*/
void setPending(boolean b)
{
@@ -207,7 +207,7 @@
}
/**
- * NEEDSDOC Method reset
+ * Reset Pending flag to indicate that this event is not pending
*
*/
void reset()
1.5 +11 -9
xml-xalan/java/src/org/apache/xalan/transformer/QueuedStartDocument.java
Index: QueuedStartDocument.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/QueuedStartDocument.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- QueuedStartDocument.java 2000/11/13 16:27:19 1.4
+++ QueuedStartDocument.java 2000/12/13 17:22:59 1.5
@@ -85,10 +85,10 @@
}
/**
- * NEEDSDOC Method setPending
+ * Set Whether this document event is pending
*
*
- * NEEDSDOC @param b
+ * @param b Flag indicating whether this document event is pending
*/
void setPending(boolean b)
{
@@ -126,10 +126,11 @@
private boolean m_isTextEntity = false;
/**
- * NEEDSDOC Method setIsTextEntity
- *
+ * Set whether we have some document content since the last
+ * call to startDocument()
*
- * NEEDSDOC @param b
+ * @param b Flag indicating whether we have some document content since
the last
+ * call to startDocument()
*/
void setIsTextEntity(boolean b)
{
@@ -137,10 +138,11 @@
}
/**
- * NEEDSDOC Method getIsTextEntity
- *
+ * Get whether we have some document content since the last
+ * call to startDocument()
*
- * NEEDSDOC (getIsTextEntity) @return
+ * @return Flag indicating whether we have some document content since the
last
+ * call to startDocument()
*/
boolean getIsTextEntity()
{
@@ -148,7 +150,7 @@
}
/**
- * NEEDSDOC Method reset
+ * Reset this event's isPending and isTextEntity flags to false
*
*/
void reset()
1.6 +33 -29
xml-xalan/java/src/org/apache/xalan/transformer/QueuedStartElement.java
Index: QueuedStartElement.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/QueuedStartElement.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- QueuedStartElement.java 2000/11/23 04:58:20 1.5
+++ QueuedStartElement.java 2000/12/13 17:23:00 1.6
@@ -101,19 +101,19 @@
*/
private String m_name;
- /** NEEDSDOC Field m_url */
+ /** Namespace URL of the element */
private String m_url;
- /** NEEDSDOC Field m_localName */
+ /** Local part of qualified name of the element */
private String m_localName;
/**
* Set the pending element names.
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
- * NEEDSDOC @param atts
+ * @param ns Namespace URI of the element
+ * @param localName Local part of qName of element
+ * @param name Name of element
+ * @param atts List of attributes of the element
*/
void setPending(String ns, String localName, String name, Attributes atts)
{
@@ -131,7 +131,7 @@
/**
* Get the list of pending attributes.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the list of pending attributes.
*/
MutableAttrListImpl getAttrs()
{
@@ -141,11 +141,11 @@
/**
* Set an attribute in the pending attributes list.
*
- * NEEDSDOC @param uri
- * NEEDSDOC @param localName
- * NEEDSDOC @param qName
- * NEEDSDOC @param type
- * NEEDSDOC @param value
+ * @param uri Namespace URI of attribute
+ * @param localName Local part of qname of the attribute
+ * @param qName Qualified name of attribute
+ * @param type The attribute type as a string.
+ * @param value Attribute value
*/
void addAttribute(String uri, String localName, String qName, String type,
String value)
@@ -154,13 +154,13 @@
}
/**
- * NEEDSDOC Method isElement
+ * Return whether the given element matches this pending element' name
*
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
+ * @param ns Namespace URI of given element
+ * @param localName Local part of qname of given element
*
- * NEEDSDOC (isElement) @return
+ * @return True if the given element matches this.
*/
boolean isElement(String ns, String localName)
{
@@ -180,7 +180,7 @@
/**
* Get the pending element name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the pending element name.
*/
String getName()
{
@@ -188,9 +188,9 @@
}
/**
- * Get the pending element name.
+ * Get the pending element namespace URI.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the pending element namespace URI.
*/
String getURL()
{
@@ -200,7 +200,7 @@
/**
* Get the the local name.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the pending element local name.
*/
String getLocalName()
{
@@ -208,10 +208,12 @@
}
/**
- * NEEDSDOC Method nsDeclsHaveBeenAdded
+ * Return whether Namespace declarations have been added to
+ * this element
*
*
- * NEEDSDOC (nsDeclsHaveBeenAdded) @return
+ * @return whether Namespace declarations have been added to
+ * this element
*/
boolean nsDeclsHaveBeenAdded()
{
@@ -219,10 +221,12 @@
}
/**
- * NEEDSDOC Method setNSDeclsHaveBeenAdded
+ * Set whether Namespace declarations have been added to
+ * this element
*
*
- * NEEDSDOC @param b
+ * @param b Flag indicating whether Namespace declarations
+ * have been added to this element
*/
void setNSDeclsHaveBeenAdded(boolean b)
{
@@ -230,7 +234,7 @@
}
/**
- * NEEDSDOC Method reset
+ * Reset this pending element
*
*/
void reset()
@@ -246,15 +250,15 @@
m_namespaces = null;
}
- /** NEEDSDOC Field m_namespaces */
+ /** Vector of namespaces for this element */
Vector m_namespaces = null;
/**
- * NEEDSDOC Method startPrefixMapping
+ * Start Prefix mapping for this element
*
*
- * NEEDSDOC @param prefix
- * NEEDSDOC @param uri
+ * @param prefix Prefix to map
+ * @param uri Namespace URI for the given prefix
*/
void startPrefixMapping(String prefix, String uri)
{
1.3 +5 -5
xml-xalan/java/src/org/apache/xalan/transformer/ResultNameSpace.java
Index: ResultNameSpace.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/ResultNameSpace.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ResultNameSpace.java 2000/10/30 18:57:01 1.2
+++ ResultNameSpace.java 2000/12/13 17:23:00 1.3
@@ -65,21 +65,21 @@
public class ResultNameSpace
{
- /** NEEDSDOC Field m_next */
+ /** Pointer to next ResultNameSpace */
public ResultNameSpace m_next = null;
- /** NEEDSDOC Field m_prefix */
+ /** Prefix of namespace */
public String m_prefix;
- /** NEEDSDOC Field m_uri */
+ /** Namespace URI */
public String m_uri; // if null, then Element namespace is empty.
/**
* Construct a namespace for placement on the
* result tree namespace stack.
*
- * NEEDSDOC @param prefix
- * NEEDSDOC @param uri
+ * @param prefix of result namespace
+ * @param uri URI of result namespace
*/
public ResultNameSpace(String prefix, String uri)
{
1.28 +98 -92
xml-xalan/java/src/org/apache/xalan/transformer/ResultTreeHandler.java
Index: ResultTreeHandler.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/ResultTreeHandler.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- ResultTreeHandler.java 2000/12/08 00:00:36 1.27
+++ ResultTreeHandler.java 2000/12/13 17:23:01 1.28
@@ -99,7 +99,7 @@
implements ContentHandler, LexicalHandler
{
- /** NEEDSDOC Field DEBUG */
+ /** Indicate whether running in Debug mode */
private static final boolean DEBUG = false;
/**
@@ -111,8 +111,8 @@
* Create a new result tree handler. The real content
* handler will be the ContentHandler passed as an argument.
*
- * NEEDSDOC @param transformer
- * NEEDSDOC @param realHandler
+ * @param transformer non-null transformer instance
+ * @param realHandler Content Handler instance
*/
public ResultTreeHandler(TransformerImpl transformer,
ContentHandler realHandler)
@@ -123,8 +123,8 @@
/**
* Initializer method.
*
- * NEEDSDOC @param transformer
- * NEEDSDOC @param realHandler
+ * @param transformer non-null transformer instance
+ * @param realHandler Content Handler instance
*/
public void init(TransformerImpl transformer, ContentHandler realHandler)
{
@@ -197,9 +197,9 @@
* element, so that attributes can still be added to it before
* the real "startElement" is called on the result tree listener.
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
+ * @param ns Namespace URI of element
+ * @param localName Local part of qname of element
+ * @param name Name of element
*
* @throws org.xml.sax.SAXException
*/
@@ -214,10 +214,10 @@
* element, so that attributes can still be added to it before
* the real "startElement" is called on the result tree listener.
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
- * NEEDSDOC @param atts
+ * @param ns Namespace URI of element
+ * @param localName Local part of qname of element
+ * @param name Name of element
+ * @param atts List of attributes for the element
*
* @throws org.xml.sax.SAXException
*/
@@ -257,9 +257,9 @@
/**
* Bottleneck the endElement event.
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
- * NEEDSDOC @param name
+ * @param ns Namespace URI of element
+ * @param localName Local part of qname of element
+ * @param name Name of element
*
* @throws org.xml.sax.SAXException
*/
@@ -288,7 +288,7 @@
m_nsSupport.popContext();
}
- /** NEEDSDOC Field m_nsContextPushed */
+ /** Indicate whether a namespace context was pushed */
boolean m_nsContextPushed = false;
/**
@@ -330,12 +330,13 @@
}
/**
- * NEEDSDOC Method startPrefixMapping
+ * Begin the scope of a prefix-URI Namespace mapping.
*
*
- * NEEDSDOC @param prefix
- * NEEDSDOC @param uri
- * NEEDSDOC @param shouldFlush
+ * @param prefix The Namespace prefix being declared.
+ * @param uri The Namespace URI the prefix is mapped to.
+ * @param shouldFlush Indicate whether pending events needs
+ * to be flushed first
*
* @throws org.xml.sax.SAXException
*/
@@ -394,9 +395,9 @@
/**
* Bottleneck the characters event.
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch Array of characters to process
+ * @param start start of characters in the array
+ * @param length Number of characters in the array
*
* @throws org.xml.sax.SAXException
*/
@@ -427,9 +428,9 @@
/**
* Bottleneck the ignorableWhitespace event.
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch Array of characters to process
+ * @param start start of characters in the array
+ * @param length Number of characters in the array
*
* @throws org.xml.sax.SAXException
*/
@@ -460,8 +461,8 @@
/**
* Bottleneck the processingInstruction event.
*
- * NEEDSDOC @param target
- * NEEDSDOC @param data
+ * @param target Processing instruction target name
+ * @param data Processing instruction data
*
* @throws org.xml.sax.SAXException
*/
@@ -484,7 +485,7 @@
/**
* Bottleneck the comment event.
*
- * NEEDSDOC @param data
+ * @param data Comment data
*
* @throws org.xml.sax.SAXException
*/
@@ -511,9 +512,9 @@
/**
* Bottleneck the comment event.
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
+ * @param ch Character array with comment data
+ * @param start start of characters in the array
+ * @param length number of characters in the array
*
* @throws org.xml.sax.SAXException
*/
@@ -538,9 +539,9 @@
}
/**
- * Bottleneck the comment event.
+ * Entity reference event.
*
- * NEEDSDOC @param name
+ * @param name Name of entity
*
* @throws org.xml.sax.SAXException
*/
@@ -568,7 +569,7 @@
/**
* Start an entity.
*
- * NEEDSDOC @param name
+ * @param name Name of the entity
*
* @throws org.xml.sax.SAXException
*/
@@ -586,7 +587,7 @@
/**
* End an entity.
*
- * NEEDSDOC @param name
+ * @param name Name of the entity
*
* @throws org.xml.sax.SAXException
*/
@@ -613,9 +614,11 @@
/**
* Start the DTD.
*
- * NEEDSDOC @param s1
- * NEEDSDOC @param s2
- * NEEDSDOC @param s3
+ * @param s1 The document type name.
+ * @param s2 The declared public identifier for the
+ * external DTD subset, or null if none was declared.
+ * @param s3 The declared system identifier for the
+ * external DTD subset, or null if none was declared.
*
* @throws org.xml.sax.SAXException
*/
@@ -712,7 +715,7 @@
/**
* Flush the pending element.
*
- * NEEDSDOC @param type
+ * @param type Event type
*
* @throws org.xml.sax.SAXException
*/
@@ -743,8 +746,8 @@
* Given a result tree fragment, walk the tree and
* output it to the result stream.
*
- * NEEDSDOC @param obj
- * NEEDSDOC @param support
+ * @param obj Result tree fragment object
+ * @param support XPath context for the result tree fragment
*
* @throws org.xml.sax.SAXException
*/
@@ -766,8 +769,8 @@
/**
* Clone an element with or without children.
*
- * NEEDSDOC @param node
- * NEEDSDOC @param shouldCloneAttributes
+ * @param node Element to clone
+ * @param shouldCloneAttributes Whether or not to clone with children
*
* @throws org.xml.sax.SAXException
*/
@@ -788,7 +791,7 @@
* To fullfill the FormatterListener interface... no action
* for the moment.
*
- * NEEDSDOC @param locator
+ * @param locator Document locator
*/
public void setDocumentLocator(Locator locator){}
@@ -798,8 +801,8 @@
* If it's not, it still needs to be declared at this point.
* TODO: This needs to be done at an earlier stage in the game... -sb
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param rawName
+ * @param ns Namespace URI of the element
+ * @param rawName Raw name of element (with prefix)
*
* @throws org.xml.sax.SAXException
*/
@@ -866,8 +869,8 @@
* Check to see if we should switch serializers based on the
* first output element being an HTML element.
*
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
+ * @param ns Namespace URI of the element
+ * @param localName Local part of name of the element
*
* @throws org.xml.sax.SAXException
*/
@@ -927,7 +930,7 @@
/**
* Copy <KBD>xmlns:</KBD> attributes in if not already in scope.
*
- * NEEDSDOC @param src
+ * @param src Source Node
*
* @throws TransformerException
*/
@@ -981,9 +984,9 @@
/**
* Given a prefix, return the namespace,
*
- * NEEDSDOC @param prefix
+ * @param prefix Given prefix name
*
- * NEEDSDOC ($objectName$) @return
+ * @return Namespace associated with the given prefix, or null
*/
public String getURI(String prefix)
{
@@ -993,9 +996,9 @@
/**
* Given a namespace, try and find a prefix.
*
- * NEEDSDOC @param namespace
+ * @param namespace Given namespace URI
*
- * NEEDSDOC ($objectName$) @return
+ * @return Prefix name associated with namespace URI
*/
public String getPrefix(String namespace)
{
@@ -1017,7 +1020,7 @@
/**
* Get the NamespaceSupport object.
*
- * NEEDSDOC ($objectName$) @return
+ * @return NamespaceSupport object.
*/
public NamespaceSupport getNamespaceSupport()
{
@@ -1027,7 +1030,7 @@
/**
* Override QueuedEvents#initQSE.
*
- * NEEDSDOC @param qse
+ * @param qse Give queued Sax event
*/
protected void initQSE(QueuedSAXEvent qse)
{
@@ -1053,7 +1056,7 @@
* Set the current content handler.
*
*
- * NEEDSDOC @param ch
+ * @param ch Content Handler to be set
* @return The current content handler, or null if none
* has been registered.
* @see #getContentHandler
@@ -1069,7 +1072,8 @@
/**
* Get a unique namespace value.
*
- * NEEDSDOC ($objectName$) @return
+ * @return a unique namespace value to be used with a
+ * fabricated prefix
*/
public int getUniqueNSValue()
{
@@ -1079,7 +1083,7 @@
/**
* Get new unique namespace prefix.
*
- * NEEDSDOC ($objectName$) @return
+ * @return Unique fabricated prefix.
*/
public String getNewUniqueNSPrefix()
{
@@ -1093,7 +1097,7 @@
* the attributes have to be fully collected before you
* can call startElement.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the pending attributes.
*/
public MutableAttrListImpl getPendingAttributes()
{
@@ -1148,13 +1152,14 @@
}
/**
- * NEEDSDOC Method isDefinedNSDecl
+ * Return whether or not a namespace declaration is defined
*
*
- * NEEDSDOC @param rawName
- * NEEDSDOC @param value
+ * @param rawName Raw name of namespace element
+ * @param value URI of given namespace
*
- * NEEDSDOC (isDefinedNSDecl) @return
+ * @return True if the namespace is already defined in list of
+ * namespaces
*/
public boolean isDefinedNSDecl(String rawName, String value)
{
@@ -1183,12 +1188,13 @@
}
/**
- * NEEDSDOC Method isDefinedNSDecl
+ * Returns whether a namespace is defined
*
*
- * NEEDSDOC @param attr
+ * @param attr Namespace attribute node
*
- * NEEDSDOC (isDefinedNSDecl) @return
+ * @return True if the namespace is already defined in
+ * list of namespaces
*/
public boolean isDefinedNSDecl(Attr attr)
{
@@ -1214,7 +1220,7 @@
* attribute templates as need be, and processing the xsl:use
* attribute.
*
- * NEEDSDOC @param attr
+ * @param attr Attribute node to add to result tree
*
* @throws TransformerException
*/
@@ -1234,7 +1240,7 @@
/**
* Copy DOM attributes to the result element.
*
- * NEEDSDOC @param src
+ * @param src Source node with the attributes
*
* @throws TransformerException
*/
@@ -1255,7 +1261,7 @@
/**
* Tell if an element is pending, to be output to the result tree.
*
- * NEEDSDOC ($objectName$) @return
+ * @return True if an element is pending
*/
public boolean isElementPending()
{
@@ -1282,7 +1288,7 @@
*/
private ContentHandler m_contentHandler;
- /** NEEDSDOC Field m_lexicalHandler */
+ /** The LexicalHandler */
private LexicalHandler m_lexicalHandler;
/**
@@ -1295,7 +1301,7 @@
*/
private int m_uniqueNSValue = 0;
- /** NEEDSDOC Field S_NAMESPACEPREFIX */
+ /** Prefix used to create unique prefix names */
private static final String S_NAMESPACEPREFIX = "ns";
/**
@@ -1311,63 +1317,63 @@
// These are passed to flushPending, to help it decide if it
// should really flush.
- /** NEEDSDOC Field EVT_SETDOCUMENTLOCATOR */
+ /** SETDOCUMENTLOCATOR event type */
private static final int EVT_SETDOCUMENTLOCATOR = 1;
- /** NEEDSDOC Field EVT_STARTDOCUMENT */
+ /** STARTDOCUMENT event type */
private static final int EVT_STARTDOCUMENT = 2;
- /** NEEDSDOC Field EVT_ENDDOCUMENT */
+ /** ENDDOCUMENT event type */
private static final int EVT_ENDDOCUMENT = 3;
- /** NEEDSDOC Field EVT_STARTPREFIXMAPPING */
+ /** STARTPREFIXMAPPING event type */
private static final int EVT_STARTPREFIXMAPPING = 4;
- /** NEEDSDOC Field EVT_ENDPREFIXMAPPING */
+ /** ENDPREFIXMAPPING event type */
private static final int EVT_ENDPREFIXMAPPING = 5;
- /** NEEDSDOC Field EVT_STARTELEMENT */
+ /** STARTELEMENT event type */
private static final int EVT_STARTELEMENT = 6;
- /** NEEDSDOC Field EVT_ENDELEMENT */
+ /** ENDELEMENT event type */
private static final int EVT_ENDELEMENT = 7;
- /** NEEDSDOC Field EVT_CHARACTERS */
+ /** CHARACTERS event type */
private static final int EVT_CHARACTERS = 8;
- /** NEEDSDOC Field EVT_IGNORABLEWHITESPACE */
+ /** IGNORABLEWHITESPACE event type */
private static final int EVT_IGNORABLEWHITESPACE = 9;
- /** NEEDSDOC Field EVT_PROCESSINGINSTRUCTION */
+ /** PROCESSINGINSTRUCTION event type */
private static final int EVT_PROCESSINGINSTRUCTION = 10;
- /** NEEDSDOC Field EVT_SKIPPEDENTITY */
+ /** SKIPPEDENTITY event type */
private static final int EVT_SKIPPEDENTITY = 11;
- /** NEEDSDOC Field EVT_COMMENT */
+ /** COMMENT event type */
private static final int EVT_COMMENT = 12;
- /** NEEDSDOC Field EVT_ENTITYREF */
+ /** ENTITYREF event type */
private static final int EVT_ENTITYREF = 13;
- /** NEEDSDOC Field EVT_STARTENTITY */
+ /** STARTENTITY event type */
private static final int EVT_STARTENTITY = 14;
- /** NEEDSDOC Field EVT_ENDENTITY */
+ /** ENDENTITY event type */
private static final int EVT_ENDENTITY = 15;
- /** NEEDSDOC Field EVT_STARTDTD */
+ /** STARTDTD event type */
private static final int EVT_STARTDTD = 16;
- /** NEEDSDOC Field EVT_ENDDTD */
+ /** ENDDTD event type */
private static final int EVT_ENDDTD = 17;
- /** NEEDSDOC Field EVT_STARTCDATA */
+ /** STARTCDATA event type */
private static final int EVT_STARTCDATA = 22;
- /** NEEDSDOC Field EVT_ENDCDATA */
+ /** ENDCDATA event type */
private static final int EVT_ENDCDATA = 23;
- /** NEEDSDOC Field EVT_NODE */
+ /** NODE event type */
private static final int EVT_NODE = 24;
}
1.6 +4 -4
xml-xalan/java/src/org/apache/xalan/transformer/SerializerSwitcher.java
Index: SerializerSwitcher.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/SerializerSwitcher.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- SerializerSwitcher.java 2000/12/06 05:53:05 1.5
+++ SerializerSwitcher.java 2000/12/13 17:23:02 1.6
@@ -81,12 +81,12 @@
{
/**
- * NEEDSDOC Method switchSerializerIfHTML
+ * Switch to HTML serializer if element is HTML
*
*
- * NEEDSDOC @param transformer
- * NEEDSDOC @param ns
- * NEEDSDOC @param localName
+ * @param transformer Non-null transformer instance
+ * @param ns Namespace URI of the element
+ * @param localName Local part of name of element
*
* @throws TransformerException
*/
1.5 +19 -19
xml-xalan/java/src/org/apache/xalan/transformer/StackGuard.java
Index: StackGuard.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/StackGuard.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- StackGuard.java 2000/11/13 16:27:19 1.4
+++ StackGuard.java 2000/12/13 17:23:02 1.5
@@ -94,7 +94,7 @@
* infinite loop situation, when there is none.
* Post version 1.0.0, we'll make this a runtime feature.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The recursion limit.
*/
public int getRecursionLimit()
{
@@ -102,7 +102,7 @@
}
/**
- * Get the recursion limit.
+ * Set the recursion limit.
* Used for infinite loop check. If the value is -1, do not
* check for infinite loops. Anyone who wants to enable that
* check should change the value of this variable to be the
@@ -111,20 +111,20 @@
* infinite loop situation, when there is none.
* Post version 1.0.0, we'll make this a runtime feature.
*
- * NEEDSDOC @param limit
+ * @param limit The recursion limit.
*/
public void setRecursionLimit(int limit)
{
m_recursionLimit = limit;
}
- /** NEEDSDOC Field m_xslRule */
+ /** Stylesheet Template node */
Node m_xslRule;
- /** NEEDSDOC Field m_sourceXML */
+ /** Source node */
Node m_sourceXML;
- /** NEEDSDOC Field stack */
+ /** Stack where ElemTempalteElements will be pushed */
java.util.Stack stack = new java.util.Stack();
/**
@@ -137,8 +137,8 @@
* Constructor StackGuard
*
*
- * NEEDSDOC @param xslTemplate
- * NEEDSDOC @param sourceXML
+ * @param xslTemplate Current template node
+ * @param sourceXML Source Node
*/
public StackGuard(ElemTemplateElement xslTemplate, Node sourceXML)
{
@@ -147,12 +147,12 @@
}
/**
- * NEEDSDOC Method equals
+ * Overide equal method for StackGuard objects
*
*
- * NEEDSDOC @param obj
+ * @param obj StackGuard object to compare
*
- * NEEDSDOC (equals) @return
+ * @return True if the given object matches this StackGuard object
*/
public boolean equals(Object obj)
{
@@ -167,10 +167,10 @@
}
/**
- * NEEDSDOC Method print
+ * Output diagnostics if in an infinite loop
*
*
- * NEEDSDOC @param pw
+ * @param pw Non-null PrintWriter instance to use
*/
public void print(PrintWriter pw)
{
@@ -191,10 +191,10 @@
}
/**
- * NEEDSDOC Method checkForInfinateLoop
+ * Check if we are in an infinite loop
*
*
- * NEEDSDOC @param guard
+ * @param guard Current StackGuard object (matching current template)
*
* @throws TransformerException
*/
@@ -241,11 +241,11 @@
}
/**
- * NEEDSDOC Method push
+ * Push in a StackGuard object mathing given template
*
*
- * NEEDSDOC @param xslTemplate
- * NEEDSDOC @param sourceXML
+ * @param xslTemplate Current template being processed
+ * @param sourceXML Current Source Node
*
* @throws TransformerException
*/
@@ -260,7 +260,7 @@
}
/**
- * NEEDSDOC Method pop
+ * Pop out Stack of StackGuard objects
*
*/
public void pop()
1.5 +8 -7
xml-xalan/java/src/org/apache/xalan/transformer/TransformState.java
Index: TransformState.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/TransformState.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TransformState.java 2000/11/03 23:28:12 1.4
+++ TransformState.java 2000/12/13 17:23:03 1.5
@@ -90,7 +90,7 @@
* be in a default template, and thus may not be
* defined in the stylesheet.</p>
*
- * NEEDSDOC ($objectName$) @return
+ * @return the stylesheet element that produced the SAX event.
*/
ElemTemplateElement getCurrentElement();
@@ -98,7 +98,7 @@
* This method retrieves the current context node
* in the source tree.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the current context node in the source tree.
*/
Node getCurrentNode();
@@ -111,7 +111,7 @@
* be a default template, and thus may not have a template
* defined in the stylesheet.</p>
*
- * NEEDSDOC ($objectName$) @return
+ * @return the xsl:template that is in effect
*/
ElemTemplate getCurrentTemplate();
@@ -126,7 +126,7 @@
* be a default template, and thus may not have a template
* defined in the stylesheet.</p>
*
- * NEEDSDOC ($objectName$) @return
+ * @return the xsl:template that was matched.
*/
ElemTemplate getMatchedTemplate();
@@ -134,21 +134,22 @@
* Retrieves the node in the source tree that matched
* the template obtained via getMatchedTemplate().
*
- * NEEDSDOC ($objectName$) @return
+ * @return the node in the source tree that matched
+ * the template obtained via getMatchedTemplate().
*/
Node getMatchedNode();
/**
* Get the current context node list.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the current context node list.
*/
NodeIterator getContextNodeList();
/**
* Get the TrAX Transformer object in effect.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the TrAX Transformer object in effect.
*/
Transformer getTransformer();
}
1.3 +1 -1
xml-xalan/java/src/org/apache/xalan/transformer/TransformerClient.java
Index: TransformerClient.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/TransformerClient.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TransformerClient.java 2000/10/30 18:57:02 1.2
+++ TransformerClient.java 2000/12/13 17:23:04 1.3
@@ -73,7 +73,7 @@
* information about he state of the transformation. This
* method will be called before each startDocument event.
*
- * NEEDSDOC @param ts
+ * @param ts A reference to a TransformState object
*/
void setTransformState(TransformState ts);
}
1.7 +8 -8
xml-xalan/java/src/org/apache/xalan/transformer/TreeWalker2Result.java
Index: TreeWalker2Result.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/TreeWalker2Result.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- TreeWalker2Result.java 2000/11/23 04:58:22 1.6
+++ TreeWalker2Result.java 2000/12/13 17:23:04 1.7
@@ -73,20 +73,20 @@
public class TreeWalker2Result extends TreeWalker
{
- /** NEEDSDOC Field m_transformer */
+ /** The transformer instance */
TransformerImpl m_transformer;
- /** NEEDSDOC Field m_handler */
+ /** The result tree handler */
ResultTreeHandler m_handler;
- /** NEEDSDOC Field m_startNode */
+ /** Node where to start the tree walk */
Node m_startNode;
/**
* Constructor.
*
- * NEEDSDOC @param transformer
- * NEEDSDOC @param handler
+ * @param transformer Non-null transformer instance
+ * @param handler The Result tree handler to use
*/
public TreeWalker2Result(TransformerImpl transformer,
ResultTreeHandler handler)
@@ -101,7 +101,7 @@
/**
* Perform a pre-order traversal non-recursive style.
*
- * NEEDSDOC @param pos
+ * @param pos Start node for traversal
*
* @throws TransformerException
*/
@@ -114,10 +114,10 @@
}
/**
- * NEEDSDOC Method startNode
+ * Start traversal of the tree at the given node
*
*
- * NEEDSDOC @param node
+ * @param node Starting node for traversal
*
* @throws TransformerException
*/
1.3 +3 -3
xml-xalan/java/src/org/apache/xalan/transformer/XSLInfiniteLoopException.java
Index: XSLInfiniteLoopException.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/transformer/XSLInfiniteLoopException.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- XSLInfiniteLoopException.java 2000/10/30 18:57:03 1.2
+++ XSLInfiniteLoopException.java 2000/12/13 17:23:05 1.3
@@ -58,7 +58,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XSLInfiniteLoopException <needs-comment/>
+ * Class used to create an Infinite Loop Exception
*/
class XSLInfiniteLoopException
{
@@ -73,10 +73,10 @@
}
/**
- * NEEDSDOC Method getMessage
+ * Get Message associated with the exception
*
*
- * NEEDSDOC (getMessage) @return
+ * @return Message associated with the exception
*/
public String getMessage()
{
