mmidy 00/12/01 12:30:48
Modified: java/src/org/apache/xml/utils SystemIDResolver.java
TreeWalker.java URI.java UnImplNode.java
WrappedRuntimeException.java
XMLCharacterRecognizer.java
java/src/org/apache/xml/utils/res XResourceBundleBase.java
XResources_cy.java XResources_el.java
XResources_en.java XResources_he.java
XResources_hy.java XResources_ja_JP_A.java
XResources_ja_JP_HA.java XResources_ja_JP_HI.java
XResources_ja_JP_I.java XResources_ka.java
XResources_zh_CN.java XResources_zh_TW.java
Log:
Update javadoc
Revision Changes Path
1.2 +10 -7
xml-xalan/java/src/org/apache/xml/utils/SystemIDResolver.java
Index: SystemIDResolver.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/SystemIDResolver.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SystemIDResolver.java 2000/11/23 04:58:45 1.1
+++ SystemIDResolver.java 2000/12/01 20:30:13 1.2
@@ -67,18 +67,21 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class SystemIDResolver <needs-comment/>
+ * This class is used to resolve relative URIs and SystemID
+ * strings into absolute URIs.
*/
public class SystemIDResolver
{
/**
- * NEEDSDOC Method getAbsoluteURIFromRelative
+ * Get absolute URI from a given relative URI.
+ * The URI is resolved relative to the system property "user.dir"
*
*
- * NEEDSDOC @param uri
+ * @param uri Relative URI to resolve
*
- * NEEDSDOC (getAbsoluteURIFromRelative) @return
+ * @return Resolved absolute URI or the input relative URI if
+ * it could not be resolved.
*/
public static String getAbsoluteURIFromRelative(String uri)
{
@@ -99,10 +102,10 @@
/**
* Take a SystemID string and try and turn it into a good absolute URL.
*
- * NEEDSDOC @param urlString
- * NEEDSDOC @param base
+ * @param urlString SystemID string
+ * @param base Base URI to use to resolve the given systemID
*
- * NEEDSDOC ($objectName$) @return
+ * @return The resolved absolute URI
* @exception TransformerException thrown if the string can't be turned
into a URL.
*/
public static String getAbsoluteURI(String urlString, String base)
1.2 +13 -13 xml-xalan/java/src/org/apache/xml/utils/TreeWalker.java
Index: TreeWalker.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/TreeWalker.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TreeWalker.java 2000/11/23 04:58:45 1.1
+++ TreeWalker.java 2000/12/01 20:30:13 1.2
@@ -73,19 +73,19 @@
public class TreeWalker
{
- /** NEEDSDOC Field m_contentHandler */
+ /** Local reference to a ContentHandler */
private ContentHandler m_contentHandler = null;
// ARGHH!! JAXP Uses Xerces without setting the namespace processing to
ON!
// DOM2Helper m_dh = new DOM2Helper();
- /** NEEDSDOC Field m_dh */
+ /** DomHelper for this TreeWalker */
protected DOMHelper m_dh = new DOM2Helper();
/**
* Get the ContentHandler used for the tree walk.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the ContentHandler used for the tree walk
*/
public ContentHandler getcontentHandler()
{
@@ -105,7 +105,7 @@
/**
* Perform a pre-order traversal non-recursive style.
*
- * NEEDSDOC @param pos
+ * @param pos Node in the tree where to start traversal
*
* @throws TransformerException
*/
@@ -152,8 +152,8 @@
/**
* Perform a pre-order traversal non-recursive style.
*
- * NEEDSDOC @param pos
- * NEEDSDOC @param top
+ * @param pos Node in the tree where to start traversal
+ * @param top Node in the tree where to end traversal
*
* @throws TransformerException
*/
@@ -209,16 +209,16 @@
}
*/
- /** NEEDSDOC Field nextIsRaw */
+ /** Flag indicating whether following text to be processed is raw text
*/
boolean nextIsRaw = false;
/**
- * NEEDSDOC Method startNode
+ * Start processing given node
*
*
- * NEEDSDOC @param node
+ * @param node Node to process
*
- * @throws TransformerException
+ * @throws org.xml.sax.SAXException
*/
protected void startNode(Node node) throws org.xml.sax.SAXException
{
@@ -359,12 +359,12 @@
}
/**
- * NEEDSDOC Method endNode
+ * End processing of given node
*
*
- * NEEDSDOC @param node
+ * @param node Node we just finished processing
*
- * @throws TransformerException
+ * @throws org.xml.sax.SAXException
*/
protected void endNode(Node node) throws org.xml.sax.SAXException
{
1.2 +10 -10 xml-xalan/java/src/org/apache/xml/utils/URI.java
Index: URI.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/URI.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- URI.java 2000/11/23 04:58:46 1.1
+++ URI.java 2000/12/01 20:30:14 1.2
@@ -88,7 +88,7 @@
* default port for a specific scheme). Rather, it only knows the
* grammar and basic set of operations that can be applied to a URI.
*
- * @version $Id: URI.java,v 1.1 2000/11/23 04:58:46 sboag Exp $
+ * @version $Id: URI.java,v 1.2 2000/12/01 20:30:14 mmidy Exp $
*
*/
public class URI implements Serializable
@@ -1409,7 +1409,7 @@
* contains only alphanumerics, '+','-' and '.'.
*
*
- * NEEDSDOC @param p_scheme
+ * @param p_scheme The sheme name to check
* @return true if the scheme is conformant, false otherwise
*/
public static boolean isConformantSchemeName(String p_scheme)
@@ -1449,7 +1449,7 @@
* & by a '.'. See RFC 2396 Section 3.2.2.
*
*
- * NEEDSDOC @param p_address
+ * @param p_address The address string to check
* @return true if the string is a syntactically valid IPv4 address
* or hostname
*/
@@ -1554,7 +1554,7 @@
* Determine whether a char is a digit.
*
*
- * NEEDSDOC @param p_char
+ * @param p_char the character to check
* @return true if the char is betweeen '0' and '9', false otherwise
*/
private static boolean isDigit(char p_char)
@@ -1566,7 +1566,7 @@
* Determine whether a character is a hexadecimal character.
*
*
- * NEEDSDOC @param p_char
+ * @param p_char the character to check
* @return true if the char is betweeen '0' and '9', 'a' and 'f'
* or 'A' and 'F', false otherwise
*/
@@ -1580,7 +1580,7 @@
* Determine whether a char is an alphabetic character: a-z or A-Z
*
*
- * NEEDSDOC @param p_char
+ * @param p_char the character to check
* @return true if the char is alphabetic, false otherwise
*/
private static boolean isAlpha(char p_char)
@@ -1593,7 +1593,7 @@
* Determine whether a char is an alphanumeric: 0-9, a-z or A-Z
*
*
- * NEEDSDOC @param p_char
+ * @param p_char the character to check
* @return true if the char is alphanumeric, false otherwise
*/
private static boolean isAlphanum(char p_char)
@@ -1606,7 +1606,7 @@
* ';', '/', '?', ':', '@', '&', '=', '+', '$' or ','
*
*
- * NEEDSDOC @param p_char
+ * @param p_char the character to check
* @return true if the string contains any reserved characters
*/
private static boolean isReservedCharacter(char p_char)
@@ -1618,7 +1618,7 @@
* Determine whether a char is an unreserved character.
*
*
- * NEEDSDOC @param p_char
+ * @param p_char the character to check
* @return true if the char is unreserved, false otherwise
*/
private static boolean isUnreservedCharacter(char p_char)
@@ -1632,7 +1632,7 @@
* characters, unreserved characters and escaped characters.
*
*
- * NEEDSDOC @param p_uric
+ * @param p_uric URI string
* @return true if the string is comprised of uric, false otherwise
*/
private static boolean isURIString(String p_uric)
1.2 +170 -159 xml-xalan/java/src/org/apache/xml/utils/UnImplNode.java
Index: UnImplNode.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/UnImplNode.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- UnImplNode.java 2000/11/23 04:58:46 1.1
+++ UnImplNode.java 2000/12/01 20:30:15 1.2
@@ -77,7 +77,7 @@
/**
* Throw an error.
*
- * NEEDSDOC @param msg
+ * @param msg Message code for the error
*/
public void error(int msg)
{
@@ -90,8 +90,8 @@
/**
* Throw an error.
*
- * NEEDSDOC @param msg
- * NEEDSDOC @param args
+ * @param msg Message code for the error
+ * @param args Array of arguments to be used in the error message
*/
public void error(int msg, Object[] args)
{
@@ -102,11 +102,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC @param newChild
+ * @param newChild New node to append to the list of this node's children
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -119,9 +119,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return false
*/
public boolean hasChildNodes()
{
@@ -132,9 +132,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return 0
*/
public short getNodeType()
{
@@ -145,9 +145,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getParentNode()
{
@@ -158,9 +158,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public NodeList getChildNodes()
{
@@ -171,9 +171,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getFirstChild()
{
@@ -184,9 +184,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getLastChild()
{
@@ -197,9 +197,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getNextSibling()
{
@@ -210,9 +210,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.NodeList
*
- * NEEDSDOC ($objectName$) @return
+ * @return 0
*/
public int getLength()
{
@@ -223,11 +223,11 @@
} // getLength():int
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.NodeList
*
- * NEEDSDOC @param index
+ * @param index index of a child of this node in its list of children
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node item(int index)
{
@@ -238,9 +238,9 @@
} // item(int):Node
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Document getOwnerDocument()
{
@@ -251,9 +251,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getTagName()
{
@@ -264,9 +264,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getNodeName()
{
@@ -276,18 +276,18 @@
return null;
}
- /** Unimplemented. */
+ /** Unimplemented. See org.w3c.dom.Node */
public void normalize()
{
error(XSLTErrorResources.ER_FUNCTION_NOT_SUPPORTED); //"normalize not
supported!");
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param name
+ * @param name Name of the element
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public NodeList getElementsByTagName(String name)
{
@@ -298,11 +298,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param oldAttr
+ * @param oldAttr Attribute to be removed from this node's list of
attributes
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -315,11 +315,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param newAttr
+ * @param newAttr Attribute node to be added to this node's list of
attributes
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -332,12 +332,12 @@
}
/**
- * NEEDSDOC Method hasAttribute
+ * Unimplemented. See org.w3c.dom.Element
*
*
- * NEEDSDOC @param name
+ * @param name Name of an attribute
*
- * NEEDSDOC (hasAttribute) @return
+ * @return false
*/
public boolean hasAttribute(String name)
{
@@ -348,13 +348,13 @@
}
/**
- * NEEDSDOC Method hasAttributeNS
+ * Unimplemented. See org.w3c.dom.Element
*
*
- * NEEDSDOC @param name
- * NEEDSDOC @param x
+ * @param name
+ * @param x
*
- * NEEDSDOC (hasAttributeNS) @return
+ * @return false
*/
public boolean hasAttributeNS(String name, String x)
{
@@ -365,12 +365,12 @@
}
/**
- * NEEDSDOC Method getAttributeNode
+ * Unimplemented. See org.w3c.dom.Element
*
*
- * NEEDSDOC @param name
+ * @param name Attribute node name
*
- * NEEDSDOC (getAttributeNode) @return
+ * @return null
*/
public Attr getAttributeNode(String name)
{
@@ -381,9 +381,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param name
+ * @param name Attribute node name to remove from list of attributes
*
* @throws DOMException
*/
@@ -393,10 +393,10 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param name
- * NEEDSDOC @param value
+ * @param name Name of attribute to set
+ * @param value Value of attribute
*
* @throws DOMException
*/
@@ -406,11 +406,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param name
+ * @param name Name of attribute to get
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getAttribute(String name)
{
@@ -421,9 +421,9 @@
}
/**
- * Introduced in DOM Level 2.
+ * Unimplemented. Introduced in DOM Level 2.
*
- * NEEDSDOC ($objectName$) @return
+ * @return false
*/
public boolean hasAttributes()
{
@@ -434,12 +434,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param localName
+ * @param namespaceURI Namespace URI of the element
+ * @param localName Local part of qualified name of the element
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public NodeList getElementsByTagNameNS(String namespaceURI,
String localName)
@@ -451,11 +451,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param newAttr
+ * @param newAttr Attribute to set
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -468,12 +468,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param localName
+ * @param namespaceURI Namespace URI of attribute node to get
+ * @param localName Local part of qualified name of attribute node to get
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Attr getAttributeNodeNS(String namespaceURI, String localName)
{
@@ -484,10 +484,10 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param localName
+ * @param namespaceURI Namespace URI of attribute node to remove
+ * @param localName Local part of qualified name of attribute node to
remove
*
* @throws DOMException
*/
@@ -498,11 +498,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param qualifiedName
- * NEEDSDOC @param value
+ * @param namespaceURI Namespace URI of attribute node to set
+ * @param localName Local part of qualified name of attribute node to set
+ * @param value value of attribute
*
* @throws DOMException
*/
@@ -514,12 +514,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Element
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param localName
+ * @param namespaceURI Namespace URI of attribute node to get
+ * @param localName Local part of qualified name of attribute node to get
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getAttributeNS(String namespaceURI, String localName)
{
@@ -530,9 +530,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node getPreviousSibling()
{
@@ -543,11 +543,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC @param deep
+ * @param deep Flag indicating whether to clone deep (clone member
variables)
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Node cloneNode(boolean deep)
{
@@ -558,9 +558,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -573,9 +573,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC @param nodeValue
+ * @param nodeValue Value to set this node to
*
* @throws DOMException
*/
@@ -585,7 +585,7 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
* NEEDSDOC @param value
*
@@ -598,7 +598,13 @@
// return null;
// }
- /** Unimplemented. */
+ /**
+ * Unimplemented. See org.w3c.dom.Node
+ *
+ * @param value Value to set this node to
+ *
+ * @throws DOMException
+ */
public void setValue(String value) throws DOMException
{
error(XSLTErrorResources.ER_FUNCTION_NOT_SUPPORTED); //"setValue not
supported!");
@@ -614,6 +620,12 @@
// {
// return this.getNodeName();
// }
+
+ /**
+ * Unimplemented. See org.w3c.dom.Node
+ *
+ * @return null
+ */
public Element getOwnerElement()
{
@@ -623,9 +635,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return False
*/
public boolean getSpecified()
{
@@ -636,9 +648,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public NamedNodeMap getAttributes()
{
@@ -649,12 +661,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC @param newChild
- * NEEDSDOC @param refChild
+ * @param newChild New child node to insert
+ * @param refChild Insert in front of this child
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -667,12 +679,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC @param newChild
- * NEEDSDOC @param oldChild
+ * @param newChild Replace existing child with this one
+ * @param oldChild Existing child to be replaced
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -685,11 +697,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC @param oldChild
+ * @param oldChild Child to be removed
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -711,8 +723,7 @@
* Level 2, version 1, this is the string "2.0". If the version is not
* specified, supporting any version of the feature will cause the
* method to return <code>true</code>.
- * @return Returns <code>true</code> if the specified feature is
- * supported on this node, <code>false</code> otherwise.
+ * @return Returns <code>false</code>
* @since DOM Level 2
*/
public boolean isSupported(String feature, String version)
@@ -721,9 +732,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getNamespaceURI()
{
@@ -734,9 +745,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getPrefix()
{
@@ -747,9 +758,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC @param prefix
+ * @param prefix Prefix to set for this node
*
* @throws DOMException
*/
@@ -759,9 +770,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public String getLocalName()
{
@@ -772,9 +783,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public DocumentType getDoctype()
{
@@ -785,9 +796,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public DOMImplementation getImplementation()
{
@@ -798,9 +809,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Element getDocumentElement()
{
@@ -811,11 +822,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param tagName
+ * @param tagName Element tag name
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -828,9 +839,9 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public DocumentFragment createDocumentFragment()
{
@@ -841,11 +852,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param data
+ * @param data Data for text node
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Text createTextNode(String data)
{
@@ -856,11 +867,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param data
+ * @param data Data for comment
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Comment createComment(String data)
{
@@ -871,11 +882,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param data
+ * @param data Data for CDATA section
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -888,12 +899,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param target
- * NEEDSDOC @param data
+ * @param target Target for Processing instruction
+ * @param data Data for Processing instruction
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -907,11 +918,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param name
+ * @param name Attribute name
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -924,11 +935,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param name
+ * @param name Entity Reference name
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -942,12 +953,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
* NEEDSDOC @param importedNode
* NEEDSDOC @param deep
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -960,12 +971,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
* NEEDSDOC @param namespaceURI
* NEEDSDOC @param qualifiedName
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -979,12 +990,12 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
* NEEDSDOC @param namespaceURI
* NEEDSDOC @param qualifiedName
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -998,11 +1009,11 @@
}
/**
- * Unimplemented.
+ * Unimplemented. See org.w3c.dom.Document
*
* NEEDSDOC @param elementId
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*/
public Element getElementById(String elementId)
{
@@ -1031,7 +1042,7 @@
* NEEDSDOC @param offset
* NEEDSDOC @param count
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
@@ -1101,7 +1112,7 @@
*
* NEEDSDOC @param offset
*
- * NEEDSDOC ($objectName$) @return
+ * @return null
*
* @throws DOMException
*/
1.2 +3 -3
xml-xalan/java/src/org/apache/xml/utils/WrappedRuntimeException.java
Index: WrappedRuntimeException.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/WrappedRuntimeException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- WrappedRuntimeException.java 2000/11/23 04:58:47 1.1
+++ WrappedRuntimeException.java 2000/12/01 20:30:15 1.2
@@ -64,14 +64,14 @@
public class WrappedRuntimeException extends RuntimeException
{
- /** NEEDSDOC Field m_exception */
+ /** Primary checked exception */
private Exception m_exception;
/**
* Construct a WrappedRuntimeException from a
* checked exception.
*
- * NEEDSDOC @param e
+ * @param e Primary checked exception
*/
public WrappedRuntimeException(Exception e)
{
@@ -84,7 +84,7 @@
/**
* Get the checked exception that this runtime exception wraps.
*
- * NEEDSDOC ($objectName$) @return
+ * @return The primary checked exception
*/
public Exception getException()
{
1.2 +11 -11
xml-xalan/java/src/org/apache/xml/utils/XMLCharacterRecognizer.java
Index: XMLCharacterRecognizer.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/XMLCharacterRecognizer.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XMLCharacterRecognizer.java 2000/11/23 04:58:47 1.1
+++ XMLCharacterRecognizer.java 2000/12/01 20:30:16 1.2
@@ -58,7 +58,8 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XMLCharacterRecognizer <needs-comment/>
+ * Class used to verify whether the specified <var>ch</var>
+ * conforms to the XML 1.0 definition of whitespace.
*/
public class XMLCharacterRecognizer
{
@@ -67,8 +68,8 @@
* Returns whether the specified <var>ch</var> conforms to the XML 1.0
definition
* of whitespace. Refer to <A
href="http://www.w3.org/TR/1998/REC-xml-19980210#NT-S";>
* the definition of <CODE>S</CODE></A> for details.
- * @param ch Character to check as XML whitespace.
- * @return =true if <var>ch</var> is XML whitespace; otherwise
=false.
+ * @param ch Character to check as XML whitespace.
+ * @return =true if <var>ch</var> is XML whitespace; otherwise =false.
*/
public static boolean isWhiteSpace(char ch)
{
@@ -77,12 +78,12 @@
/**
* Tell if the string is whitespace.
- * @param string String to be trimmed.
*
- * NEEDSDOC @param ch
- * NEEDSDOC @param start
- * NEEDSDOC @param length
- * @return The trimmed string.
+ * @param ch Character array to check as XML whitespace.
+ * @param start Start index of characters in the array
+ * @param length Number of characters in the array
+ * @return True if the characters in the array are
+ * XML whitespace; otherwise, false.
*/
public static boolean isWhiteSpace(char ch[], int start, int length)
{
@@ -100,10 +101,9 @@
/**
* Tell if the string is whitespace.
- * @param string String to be trimmed.
*
- * NEEDSDOC @param buf
- * @return The trimmed string.
+ * @param buf StringBuffer to check as XML whitespace.
+ * @return True if characters in buffer are XML whitespace, false otherwise
*/
public static boolean isWhiteSpace(StringBuffer buf)
{
1.2 +6 -6
xml-xalan/java/src/org/apache/xml/utils/res/XResourceBundleBase.java
Index: XResourceBundleBase.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResourceBundleBase.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResourceBundleBase.java 2000/11/23 04:58:50 1.1
+++ XResourceBundleBase.java 2000/12/01 20:30:22 1.2
@@ -69,18 +69,18 @@
/**
* Get the error string associated with the error code
*
- * NEEDSDOC @param errorCode
+ * @param errorCode Error code
*
- * NEEDSDOC ($objectName$) @return
+ * @return error string associated with the given error code
*/
abstract public String getMessageKey(int errorCode);
/**
- * Get the error string associated with the error code
+ * Get the warning string associated with the error code
*
- * NEEDSDOC @param errorCode
- *
- * NEEDSDOC ($objectName$) @return
+ * @param errorCode Error code
+ *
+ * @return warning string associated with the given error code
*/
abstract public String getWarningKey(int errorCode);
}
1.2 +5 -8
xml-xalan/java/src/org/apache/xml/utils/res/XResources_cy.java
Index: XResources_cy.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_cy.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_cy.java 2000/11/23 04:58:51 1.1
+++ XResources_cy.java 2000/12/01 20:30:23 1.2
@@ -60,29 +60,26 @@
import java.util.*;
-//
-// LangResources_en.properties
-//
+
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_cy <needs-comment/>
+ * The Cyrillic resource bundle.
*/
public class XResources_cy extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
- *
+ * Get the association list.
*
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "cy" }, { "help_language", "cy" }, { "language", "cy" },
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_el.java
Index: XResources_el.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_el.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_el.java 2000/11/23 04:58:51 1.1
+++ XResources_el.java 2000/12/01 20:30:24 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_el <needs-comment/>
+ * The Greek resource bundle.
*/
public class XResources_el extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "el" }, { "help_language", "el" }, { "language", "el" },
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_en.java
Index: XResources_en.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_en.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_en.java 2000/11/23 04:58:51 1.1
+++ XResources_en.java 2000/12/01 20:30:25 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_en <needs-comment/>
+ * The English resource bundle.
*/
public class XResources_en extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "en" }, { "help_language", "en" }, { "language", "en" },
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_he.java
Index: XResources_he.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_he.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_he.java 2000/11/23 04:58:51 1.1
+++ XResources_he.java 2000/12/01 20:30:25 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_he <needs-comment/>
+ * The Hebrew resource bundle.
*/
public class XResources_he extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "he" }, { "help_language", "he" }, { "language", "he" },
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_hy.java
Index: XResources_hy.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_hy.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_hy.java 2000/11/23 04:58:51 1.1
+++ XResources_hy.java 2000/12/01 20:30:26 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_hy <needs-comment/>
+ * The Armenian resource bundle.
*/
public class XResources_hy extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "hy" }, { "help_language", "hy" }, { "language", "hy" },
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_ja_JP_A.java
Index: XResources_ja_JP_A.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_ja_JP_A.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_ja_JP_A.java 2000/11/23 04:58:51 1.1
+++ XResources_ja_JP_A.java 2000/12/01 20:30:26 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_ja_JP_A <needs-comment/>
+ * The Japanese (Katakana) resource bundle.
*/
public class XResources_ja_JP_A extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "ja" }, { "help_language", "ja" }, { "language", "ja" },
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_ja_JP_HA.java
Index: XResources_ja_JP_HA.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_ja_JP_HA.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_ja_JP_HA.java 2000/11/23 04:58:51 1.1
+++ XResources_ja_JP_HA.java 2000/12/01 20:30:27 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_ja_JP_HA <needs-comment/>
+ * The Japanese (Hiragana) resource bundle.
*/
public class XResources_ja_JP_HA extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "ja" }, { "help_language", "ja" }, { "language", "ja" },
1.2 +1 -1
xml-xalan/java/src/org/apache/xml/utils/res/XResources_ja_JP_HI.java
Index: XResources_ja_JP_HI.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_ja_JP_HI.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_ja_JP_HI.java 2000/11/23 04:58:51 1.1
+++ XResources_ja_JP_HI.java 2000/12/01 20:30:27 1.2
@@ -66,7 +66,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_ja_JP_HI <needs-comment/>
+ * The Japanese (Hiragana) resource bundle.
*/
public class XResources_ja_JP_HI extends XResourceBundle
{
1.2 +1 -1
xml-xalan/java/src/org/apache/xml/utils/res/XResources_ja_JP_I.java
Index: XResources_ja_JP_I.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_ja_JP_I.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_ja_JP_I.java 2000/11/23 04:58:51 1.1
+++ XResources_ja_JP_I.java 2000/12/01 20:30:28 1.2
@@ -66,7 +66,7 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_ja_JP_I <needs-comment/>
+ * The Japanese (Katakana) resource bundle.
*/
public class XResources_ja_JP_I extends XResourceBundle
{
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_ka.java
Index: XResources_ka.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_ka.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_ka.java 2000/11/23 04:58:51 1.1
+++ XResources_ka.java 2000/12/01 20:30:29 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_ka <needs-comment/>
+ * The Georgian resource bundle.
*/
public class XResources_ka extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "ka" }, { "help_language", "ka" }, { "language", "ka" },
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_zh_CN.java
Index: XResources_zh_CN.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_zh_CN.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_zh_CN.java 2000/11/23 04:58:51 1.1
+++ XResources_zh_CN.java 2000/12/01 20:30:29 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_zh_CN <needs-comment/>
+ * The Chinese resource bundle.
*/
public class XResources_zh_CN extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "zh" }, { "help_language", "zh" }, { "language", "zh" },
1.2 +4 -5
xml-xalan/java/src/org/apache/xml/utils/res/XResources_zh_TW.java
Index: XResources_zh_TW.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xml/utils/res/XResources_zh_TW.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XResources_zh_TW.java 2000/11/23 04:58:51 1.1
+++ XResources_zh_TW.java 2000/12/01 20:30:30 1.2
@@ -66,23 +66,22 @@
/**
* <meta name="usage" content="internal"/>
- * NEEDSDOC Class XResources_zh_TW <needs-comment/>
+ * The Chinese(Taiwan) resource bundle.
*/
public class XResources_zh_TW extends XResourceBundle
{
/**
- * NEEDSDOC Method getContents
+ * Get the association list.
*
- *
- * NEEDSDOC (getContents) @return
+ * @return The association list.
*/
public Object[][] getContents()
{
return contents;
}
- /** NEEDSDOC Field contents */
+ /** The association list. */
static final Object[][] contents =
{
{ "ui_language", "zh" }, { "help_language", "zh" }, { "language", "zh" },
