This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/xerces-j.git
The following commit(s) were added to refs/heads/main by this push:
new 889ca3e93 [XERCES-1781] fixing errors in Javadoc in org.apache.xerces
(#33)
889ca3e93 is described below
commit 889ca3e938fe1ddf8330c6ee5afd42d248709f69
Author: Samael <[email protected]>
AuthorDate: Tue Oct 21 13:10:52 2025 +0100
[XERCES-1781] fixing errors in Javadoc in org.apache.xerces (#33)
---
.../xerces/jaxp/validation/DOMDocumentHandler.java | 15 +--
src/org/apache/xerces/xni/Augmentations.java | 3 +-
src/org/apache/xerces/xni/NamespaceContext.java | 17 +++-
src/org/apache/xerces/xni/QName.java | 61 ++++++++----
src/org/apache/xerces/xni/XMLAttributes.java | 36 +++----
.../xerces/xni/XMLDTDContentModelHandler.java | 42 ++++----
src/org/apache/xerces/xni/XMLDocumentHandler.java | 70 +++++++-------
.../apache/xerces/xni/XMLResourceIdentifier.java | 69 ++++++++++----
src/org/apache/xerces/xni/XNIException.java | 7 +-
src/org/apache/xerces/xni/grammars/Grammar.java | 8 +-
.../apache/xerces/xni/grammars/XMLGrammarPool.java | 4 +-
src/org/apache/xerces/xni/parser/XMLComponent.java | 9 +-
.../xerces/xni/parser/XMLComponentManager.java | 22 +++--
.../xni/parser/XMLConfigurationException.java | 9 +-
.../xni/parser/XMLDTDContentModelSource.java | 12 ++-
.../xerces/xni/parser/XMLDocumentScanner.java | 7 +-
.../xerces/xni/parser/XMLDocumentSource.java | 6 +-
.../xerces/xpointer/ElementSchemePointer.java | 18 ++--
.../apache/xerces/xpointer/XPointerHandler.java | 12 ++-
src/org/apache/xerces/xs/PSVIProvider.java | 13 ++-
.../apache/xerces/xs/XSComplexTypeDefinition.java | 7 +-
src/org/apache/xerces/xs/XSElementDeclaration.java | 17 ++--
src/org/apache/xerces/xs/XSException.java | 3 +-
src/org/apache/xerces/xs/XSImplementation.java | 10 +-
src/org/apache/xerces/xs/XSLoader.java | 30 +++---
src/org/apache/xerces/xs/XSModel.java | 106 ++++++++++-----------
src/org/apache/xerces/xs/datatypes/XSDateTime.java | 4 +-
27 files changed, 368 insertions(+), 249 deletions(-)
diff --git a/src/org/apache/xerces/jaxp/validation/DOMDocumentHandler.java
b/src/org/apache/xerces/jaxp/validation/DOMDocumentHandler.java
index dc471d336..ae2358942 100644
--- a/src/org/apache/xerces/jaxp/validation/DOMDocumentHandler.java
+++ b/src/org/apache/xerces/jaxp/validation/DOMDocumentHandler.java
@@ -47,8 +47,8 @@ interface DOMDocumentHandler extends XMLDocumentHandler {
* A document type declaration.
*
* @param node a DocumentType node
- *
- * @exception XNIException Thrown by handler to signal an error.
+ *
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void doctypeDecl(DocumentType node) throws XNIException;
@@ -60,8 +60,8 @@ interface DOMDocumentHandler extends XMLDocumentHandler {
* A comment.
*
* @param node a Comment node
- *
- * @exception XNIException Thrown by application to signal an error.
+ *
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void comment(Comment node) throws XNIException;
@@ -75,10 +75,11 @@ interface DOMDocumentHandler extends XMLDocumentHandler {
* element attributes but are <strong>not</strong> parsed or presented
* to the application as anything other than text. The application is
* responsible for parsing the data.
- *
+ * </p>
+ *
* @param node a ProcessingInstruction node
- *
- * @exception XNIException Thrown by handler to signal an error.
+ *
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void processingInstruction(ProcessingInstruction node) throws
XNIException;
diff --git a/src/org/apache/xerces/xni/Augmentations.java
b/src/org/apache/xerces/xni/Augmentations.java
index a55d3435d..5a9035fc1 100644
--- a/src/org/apache/xerces/xni/Augmentations.java
+++ b/src/org/apache/xerces/xni/Augmentations.java
@@ -73,8 +73,9 @@ public interface Augmentations {
/**
- * Returns an enumeration of the keys in the Augmentations structure
+ * Returns an enumeration of the keys in the Augmentations structure.
*
+ * @return an {@link Enumeration} of the keys in the Augmentations
structure
*/
public Enumeration keys ();
diff --git a/src/org/apache/xerces/xni/NamespaceContext.java
b/src/org/apache/xerces/xni/NamespaceContext.java
index 18aa750c1..3271dac56 100644
--- a/src/org/apache/xerces/xni/NamespaceContext.java
+++ b/src/org/apache/xerces/xni/NamespaceContext.java
@@ -63,22 +63,24 @@ public interface NamespaceContext {
* of each XML element: the new context will automatically inherit
* the declarations of its parent context, but it will also keep
* track of which declarations were made within this context.
- * <p>
+ * </p>
*
* @see #popContext
*/
public void pushContext();
- /**
+ /**
* Revert to the previous Namespace context.
* <p>
* The context should be popped at the end of each
* XML element. After popping the context, all Namespace prefix
* mappings that were previously in force are restored.
+ * </p>
* <p>
* Users must not attempt to declare additional Namespace
* prefixes after popping a context, unless you push another
* context first.
+ * </p>
*
* @see #pushContext
*/
@@ -90,12 +92,15 @@ public interface NamespaceContext {
* This method declares a prefix in the current Namespace
* context; the prefix will remain in force until this context
* is popped, unless it is shadowed in a descendant context.
+ * </p>
* <p>
* Note that to declare a default Namespace, use the empty string.
* The prefixes "xml" and "xmlns" can't be rebound.
+ * </p>
* <p>
* Note that you must <em>not</em> declare a prefix after
* you've pushed and popped another Namespace.
+ * </p>
*
* @param prefix The prefix to declare, or null for the empty
* string.
@@ -115,6 +120,7 @@ public interface NamespaceContext {
* This method looks up the prefix in the current context. If no mapping
* is found, this methods will continue lookup in the parent context(s).
* Use the empty string ("") for the default Namespace.
+ * </p>
*
* @param prefix The prefix to look up.
*
@@ -131,6 +137,7 @@ public interface NamespaceContext {
* this method will make an arbitrary selection
* If no mapping is found, this methods will continue lookup in the
* parent context(s).
+ * </p>
*
* @param uri The namespace URI to look up.
*
@@ -144,6 +151,8 @@ public interface NamespaceContext {
/**
* Return a count of locally declared prefixes, including
* the default prefix if bound.
+ *
+ * @return a count of locally declared prefixes
*/
public int getDeclaredPrefixCount();
@@ -156,7 +165,9 @@ public interface NamespaceContext {
* Return an enumeration of all prefixes whose declarations are active
* in the current context. This includes declarations from parent contexts
* that have not been overridden.
- * @return Enumeration
+ *
+ * @return an {@link Enumeration} of all prefixes whose declarations are
active
+ * in the current context
*/
public Enumeration getAllPrefixes();
diff --git a/src/org/apache/xerces/xni/QName.java
b/src/org/apache/xerces/xni/QName.java
index 26e843141..c49835787 100644
--- a/src/org/apache/xerces/xni/QName.java
+++ b/src/org/apache/xerces/xni/QName.java
@@ -24,6 +24,7 @@ package org.apache.xerces.xni;
* To be used correctly, the strings must be identical references for
* equal strings. Within the parser, these values are considered symbols
* and should always be retrieved from the <code>SymbolTable</code>.
+ * </p>
*
* @see <a
href="../../../../../xerces2/org/apache/xerces/util/SymbolTable.html">org.apache.xerces.util.SymbolTable</a>
*
@@ -39,26 +40,23 @@ public class QName
//
/**
- * The qname prefix. For example, the prefix for the qname "a:foo"
- * is "a".
+ * The qname's prefix. For example, the prefix for the qname "a:foo" is
"a".
*/
public String prefix;
/**
- * The qname localpart. For example, the localpart for the qname "a:foo"
- * is "foo".
+ * The qname's local part. For example, the localpart for the qname
"a:foo" is "foo".
*/
public String localpart;
/**
- * The qname rawname. For example, the rawname for the qname "a:foo"
- * is "a:foo".
+ * The qname's raw name. For example, the rawname for the qname "a:foo" is
"a:foo".
*/
public String rawname;
/**
- * The URI to which the qname prefix is bound. This binding must be
- * performed by a XML Namespaces aware processor.
+ * The URI to which the qname's prefix is bound. This binding must be
+ * performed by a XML Namespace-aware processor.
*/
public String uri;
@@ -71,12 +69,21 @@ public class QName
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix the qname prefix (e.g. "a")
+ * @param localpart the qname local part (e.g. "foo")
+ * @param rawname the qname raw name (e.g. "a:foo")
+ * @param uri the URI binding (e.g. "http://foo.com/mybinding";)
+ */
public QName(String prefix, String localpart, String rawname, String uri) {
setValues(prefix, localpart, rawname, uri);
} // <init>(String,String,String,String)
- /** Constructs a copy of the specified QName. */
+ /**
+ * Constructs a copy of the specified QName.
+ * @param qname the qualified name
+ */
public QName(QName qname) {
setValues(qname);
} // <init>(QName)
@@ -88,7 +95,7 @@ public class QName
/**
* Convenience method to set the values of the qname components.
*
- * @param qname The qualified name to be copied.
+ * @param qname the qualified name to be copied
*/
public void setValues(QName qname) {
prefix = qname.prefix;
@@ -100,10 +107,10 @@ public class QName
/**
* Convenience method to set the values of the qname components.
*
- * @param prefix The qname prefix. (e.g. "a")
- * @param localpart The qname localpart. (e.g. "foo")
- * @param rawname The qname rawname. (e.g. "a:foo")
- * @param uri The URI binding. (e.g. "http://foo.com/mybinding";)
+ * @param prefix the qname prefix. (e.g. "a")
+ * @param localpart the qname local part. (e.g. "foo")
+ * @param rawname the qname raw name. (e.g. "a:foo")
+ * @param uri the URI binding. (e.g. "http://foo.com/mybinding";)
*/
public void setValues(String prefix, String localpart, String rawname,
String uri) {
@@ -125,7 +132,11 @@ public class QName
// Cloneable methods
//
- /** Returns a clone of this object. */
+ /**
+ * Returns a clone of this object.
+ *
+ * @return a clone of this object
+ */
public Object clone() {
return new QName(this);
} // clone():Object
@@ -134,7 +145,11 @@ public class QName
// Object methods
//
- /** Returns the hashcode for this object. */
+ /**
+ * Returns the hashcode for this object.
+ *
+ * @return the hashcode for this object
+ */
public int hashCode() {
if (uri != null) {
return uri.hashCode() +
@@ -143,7 +158,11 @@ public class QName
return (rawname != null) ? rawname.hashCode() : 0;
} // hashCode():int
- /** Returns true if the two objects are equal. */
+ /**
+ * Returns true if the two objects are equal.
+ *
+ * @return true if the two objects are equal
+ */
public boolean equals(Object object) {
if (object instanceof QName) {
QName qname = (QName)object;
@@ -158,7 +177,11 @@ public class QName
return false;
} // equals(Object):boolean
- /** Returns a string representation of this object. */
+ /**
+ * Returns a string representation of this object.
+ *
+ * @return a string representation of this object
+ */
public String toString() {
StringBuffer str = new StringBuffer();
diff --git a/src/org/apache/xerces/xni/XMLAttributes.java
b/src/org/apache/xerces/xni/XMLAttributes.java
index be378d1e2..0285ed232 100644
--- a/src/org/apache/xerces/xni/XMLAttributes.java
+++ b/src/org/apache/xerces/xni/XMLAttributes.java
@@ -90,6 +90,9 @@ public interface XMLAttributes {
* <p>
* Once you know the number of attributes, you can iterate
* through the list.
+ * </p>
+ *
+ * @return the number of attributes in the list
*
* @see #getURI(int)
* @see #getLocalName(int)
@@ -102,10 +105,10 @@ public interface XMLAttributes {
/**
* Look up the index of an attribute by XML 1.0 qualified name.
*
- * @param qName The qualified (prefixed) name.
+ * @param qName the qualified (prefixed) name
*
- * @return The index of the attribute, or -1 if it does not
- * appear in the list.
+ * @return the index of the attribute, or -1 if it does not
+ * appear in the list
*/
public int getIndex(String qName);
@@ -141,7 +144,8 @@ public interface XMLAttributes {
/**
* Returns the prefix of the attribute at the specified index.
*
- * @param index The index of the attribute.
+ * @param index the index of the attribute
+ * @return the prefix of the attribute at the specified index
*/
public String getPrefix(int index);
@@ -229,11 +233,11 @@ public interface XMLAttributes {
* See {@link #getType(int) getType(int)} for a description
* of the possible types.
*
- * @param qName The XML 1.0 qualified name.
+ * @param qName the XML 1.0 qualified name
*
- * @return The attribute type as a string, or null if the
+ * @return the attribute type as a string, or null if the
* attribute is not in the list or if qualified names
- * are not available.
+ * are not available
*/
public String getType(String qName);
@@ -287,11 +291,11 @@ public interface XMLAttributes {
* See {@link #getValue(int) getValue(int)} for a description
* of the possible values.
*
- * @param qName The XML 1.0 qualified name.
+ * @param qName the XML 1.0 qualified name
*
- * @return The attribute value as a string, or null if the
+ * @return the attribute value as a string, or null if the
* attribute is not in the list or if qualified names
- * are not available.
+ * are not available
*/
public String getValue(String qName);
@@ -324,7 +328,8 @@ public interface XMLAttributes {
* index. If no non-normalized value is set, this method will return
* the same value as the <code>getValue(int)</code> method.
*
- * @param attrIndex The attribute index.
+ * @param attrIndex the attribute index
+ * @return the non-normalized value of the attribute at the specified index
*/
public String getNonNormalizedValue(int attrIndex);
@@ -341,7 +346,8 @@ public interface XMLAttributes {
/**
* Returns true if the attribute is specified in the instance document.
*
- * @param attrIndex The attribute index.
+ * @param attrIndex The attribute index
+ * @return true if the attribute is specified in the instance document
*/
public boolean isSpecified(int attrIndex);
@@ -359,7 +365,7 @@ public interface XMLAttributes {
*
* @param uri The Namespace URI, or the empty string if
* the name has no Namespace URI.
- * @param localPart
+ * @param localPart The attribute's local name
* @return Augmentations
*/
public Augmentations getAugmentations (String uri, String localPart);
@@ -367,12 +373,10 @@ public interface XMLAttributes {
/**
* Look up an augmentation by XML 1.0 qualified name.
- * <p>
*
- * @param qName The XML 1.0 qualified name.
+ * @param qName the XML 1.0 qualified name
*
* @return Augmentations
- *
*/
public Augmentations getAugmentations(String qName);
diff --git a/src/org/apache/xerces/xni/XMLDTDContentModelHandler.java
b/src/org/apache/xerces/xni/XMLDTDContentModelHandler.java
index 111d043a3..0bfe1da45 100644
--- a/src/org/apache/xerces/xni/XMLDTDContentModelHandler.java
+++ b/src/org/apache/xerces/xni/XMLDTDContentModelHandler.java
@@ -199,47 +199,43 @@ public interface XMLDTDContentModelHandler {
/**
* A referenced element in a mixed or children content model.
*
- * @param elementName The name of the referenced element.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param elementName the name of the referenced element
+ * @param augmentations additional information that may include infoset
augmentations
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*/
- public void element(String elementName, Augmentations augmentations)
+ public void element(String elementName, Augmentations augmentations)
throws XNIException;
/**
* The separator between choices or sequences of a mixed or children
* content model.
*
- * @param separator The type of children separator.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param separator the type of children separator
+ * @param augmentations additional information that may include infoset
augmentations
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*
* @see #SEPARATOR_CHOICE
* @see #SEPARATOR_SEQUENCE
*/
- public void separator(short separator, Augmentations augmentations)
+ public void separator(short separator, Augmentations augmentations)
throws XNIException;
/**
* The occurrence count for a child in a children content model or
* for the mixed content model group.
*
- * @param occurrence The occurrence count for the last element
- * or group.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param occurrence the occurrence count for the last element or group
+ * @param augmentations additional information that may include infoset
augmentations
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*
* @see #OCCURS_ZERO_OR_ONE
* @see #OCCURS_ZERO_OR_MORE
* @see #OCCURS_ONE_OR_MORE
*/
- public void occurrence(short occurrence, Augmentations augmentations)
+ public void occurrence(short occurrence, Augmentations augmentations)
throws XNIException;
/**
@@ -262,10 +258,20 @@ public interface XMLDTDContentModelHandler {
*/
public void endContentModel(Augmentations augmentations) throws
XNIException;
- // set content model source
+ /**
+ * Set content model source.
+ *
+ * @param source content model source
+ * @see XMLDTDContentModelSource
+ */
public void setDTDContentModelSource(XMLDTDContentModelSource source);
- // get content model source
+ /**
+ * Get content model source.
+ *
+ * @return content model source
+ * @see XMLDTDContentModelSource
+ */
public XMLDTDContentModelSource getDTDContentModelSource();
} // interface XMLDTDContentModelHandler
diff --git a/src/org/apache/xerces/xni/XMLDocumentHandler.java
b/src/org/apache/xerces/xni/XMLDocumentHandler.java
index e52e9f174..a7c41659b 100644
--- a/src/org/apache/xerces/xni/XMLDocumentHandler.java
+++ b/src/org/apache/xerces/xni/XMLDocumentHandler.java
@@ -59,10 +59,9 @@ public interface XMLDocumentHandler {
* if that information is important.
*
* @param augs Additional information that may include infoset
augmentations
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
- public void startDocument(XMLLocator locator, String encoding,
+ public void startDocument(XMLLocator locator, String encoding,
NamespaceContext namespaceContext,
Augmentations augs)
throws XNIException;
@@ -78,8 +77,7 @@ public interface XMLDocumentHandler {
* @param standalone The standalone value, or null if not specified.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void xmlDecl(String version, String encoding, String standalone,
Augmentations augs)
throws XNIException;
@@ -89,14 +87,13 @@ public interface XMLDocumentHandler {
*
* @param rootElement
* The name of the root element.
- * @param publicId The public identifier if an external DTD or null
+ * @param publicId The identifier if an external DTD or null
* if the external DTD is specified using SYSTEM.
* @param systemId The system identifier if an external DTD, null
* otherwise.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void doctypeDecl(String rootElement, String publicId, String
systemId, Augmentations augs)
throws XNIException;
@@ -107,8 +104,7 @@ public interface XMLDocumentHandler {
* @param text The text in the comment.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by application to signal an error.
+ * @exception XNIException Thrown by application to signal an error.
*/
public void comment(XMLString text, Augmentations augs) throws
XNIException;
@@ -127,8 +123,7 @@ public interface XMLDocumentHandler {
* @param data The data or null if none specified.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void processingInstruction(String target, XMLString data,
Augmentations augs)
throws XNIException;
@@ -140,8 +135,7 @@ public interface XMLDocumentHandler {
* @param attributes The element attributes.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void startElement(QName element, XMLAttributes attributes,
Augmentations augs)
throws XNIException;
@@ -153,8 +147,7 @@ public interface XMLDocumentHandler {
* @param attributes The element attributes.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void emptyElement(QName element, XMLAttributes attributes,
Augmentations augs)
throws XNIException;
@@ -164,7 +157,8 @@ public interface XMLDocumentHandler {
* <p>
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
- *
+ * </p>
+ *
* @param name The name of the general entity.
* @param identifier The resource identifier.
* @param encoding The auto-detected IANA encoding name of the entity
@@ -174,9 +168,9 @@ public interface XMLDocumentHandler {
* parsed from a java.io.Reader).
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
- public void startGeneralEntity(String name,
+ public void startGeneralEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
Augmentations augs) throws XNIException;
@@ -196,8 +190,7 @@ public interface XMLDocumentHandler {
* @param encoding The IANA encoding name of the entity.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void textDecl(String version, String encoding, Augmentations augs)
throws XNIException;
@@ -210,8 +203,7 @@ public interface XMLDocumentHandler {
* @param name The name of the entity.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void endGeneralEntity(String name, Augmentations augs) throws
XNIException;
@@ -221,8 +213,7 @@ public interface XMLDocumentHandler {
* @param text The content.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void characters(XMLString text, Augmentations augs) throws
XNIException;
@@ -237,8 +228,7 @@ public interface XMLDocumentHandler {
* @param text The ignorable whitespace.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void ignorableWhitespace(XMLString text, Augmentations augs) throws
XNIException;
@@ -248,8 +238,7 @@ public interface XMLDocumentHandler {
* @param element The name of the element.
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void endElement(QName element, Augmentations augs) throws
XNIException;
@@ -258,8 +247,7 @@ public interface XMLDocumentHandler {
*
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void startCDATA(Augmentations augs) throws XNIException;
@@ -268,8 +256,7 @@ public interface XMLDocumentHandler {
*
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void endCDATA(Augmentations augs) throws XNIException;
@@ -278,17 +265,26 @@ public interface XMLDocumentHandler {
*
* @param augs Additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
*/
public void endDocument(Augmentations augs) throws XNIException;
- /** Sets the document source. */
+ /**
+ * Sets the document source.
+ *
+ * @param source the document source
+ * @see XMLDocumentSource
+ */
public void setDocumentSource(XMLDocumentSource source);
- /** Returns the document source. */
+ /**
+ * Returns the document source.
+ *
+ * @return the document source
+ * @see XMLDocumentSource
+ */
public XMLDocumentSource getDocumentSource();
} // interface XMLDocumentHandler
diff --git a/src/org/apache/xerces/xni/XMLResourceIdentifier.java
b/src/org/apache/xerces/xni/XMLResourceIdentifier.java
index 621452d8d..20ce4f2e4 100644
--- a/src/org/apache/xerces/xni/XMLResourceIdentifier.java
+++ b/src/org/apache/xerces/xni/XMLResourceIdentifier.java
@@ -19,44 +19,81 @@ package org.apache.xerces.xni;
/**
* <p> This represents the basic physical description of the location of any
- * XML resource (a Schema grammar, a DTD, a general entity etc.) </p>
+ * XML resource (a Schema grammar, a DTD, a general entity etc.)</p>
*
* @author Neil Graham, IBM
* @version $Id$
*/
-
public interface XMLResourceIdentifier {
- /** Sets the public identifier. */
+ /**
+ * Sets the public identifier.
+ *
+ * @param publicId Sets the identifier
+ */
public void setPublicId(String publicId);
- /** Returns the public identifier. */
+ /**
+ * Returns the public identifier.
+ *
+ * @return The public identifier
+ */
public String getPublicId();
- /** Sets the expanded system identifier. */
+ /**
+ * Sets the expanded system identifier.
+ *
+ * @param systemId Sets the expanded system identifier.
+ */
public void setExpandedSystemId(String systemId);
- /** Returns the expanded system identifier. */
+ /**
+ * Returns the expanded system identifier.
+ *
+ * @return The expanded system identifier
+ */
public String getExpandedSystemId();
- /** Sets the literal system identifier. */
+ /**
+ * Sets the literal system identifier.
+ *
+ * @param systemId Sets the literal system identifier
+ */
public void setLiteralSystemId(String systemId);
- /** Returns the literal system identifier. */
+ /**
+ * Returns the literal system identifier.
+ *
+ * @return the literal system identifier
+ */
public String getLiteralSystemId();
- /** Sets the base URI against which the literal SystemId is to be
- resolved.*/
- public void setBaseSystemId(String systemId);
-
- /** <p> Returns the base URI against which the literal SystemId is to be
- resolved. </p> */
+ /**
+ * Sets the base URI against which the literal SystemId is to be resolved.
+ *
+ * @param systemId Sets the base URI against which the literal SystemId is
to be resolved
+ */
+ public void setBaseSystemId(String systemId);
+
+ /**
+ * Returns the base URI against which the literal SystemId is to be
resolved.
+ *
+ * @return the base URI against which the literal SystemId is to be
resolved
+ */
public String getBaseSystemId();
- /** Sets the namespace of the resource. */
+ /**
+ * Sets the namespace of the resource.
+ *
+ * @param namespace the namespace of the resource
+ */
public void setNamespace(String namespace);
- /** Returns the namespace of the resource. */
+ /**
+ * Returns the namespace of the resource.
+ *
+ * @return the namespace of the resource
+ */
public String getNamespace();
} // XMLResourceIdentifier
diff --git a/src/org/apache/xerces/xni/XNIException.java
b/src/org/apache/xerces/xni/XNIException.java
index 31008a2dc..eb7f01e5b 100644
--- a/src/org/apache/xerces/xni/XNIException.java
+++ b/src/org/apache/xerces/xni/XNIException.java
@@ -26,6 +26,7 @@ package org.apache.xerces.xni;
* <code>RuntimeException</code>, XNI handlers and components are
* not required to catch XNI exceptions but may explicitly catch
* them, if so desired.
+ * </p>
*
* @author Andy Clark, IBM
*
@@ -82,7 +83,11 @@ public class XNIException
// Public methods
//
- /** Returns the wrapped exception. */
+ /**
+ * Returns the wrapped exception.
+ *
+ * @return the wrapped exception
+ */
public Exception getException() {
return fException != this ? fException : null;
} // getException():Exception
diff --git a/src/org/apache/xerces/xni/grammars/Grammar.java
b/src/org/apache/xerces/xni/grammars/Grammar.java
index da9d97936..9dea057e9 100644
--- a/src/org/apache/xerces/xni/grammars/Grammar.java
+++ b/src/org/apache/xerces/xni/grammars/Grammar.java
@@ -30,7 +30,8 @@ package org.apache.xerces.xni.grammars;
* the Grammar object. You <em>can</em> create equivalent validation
* rules in your choice of grammar syntax but there is no guarantee that
* the input and output will be the same.
- *
+ * </p>
+ *
* <p> Right now, this class is largely a shell; eventually,
* it will be enriched by having more expressive methods added. </p>
* will be moved from dtd.Grammar here.
@@ -46,8 +47,9 @@ package org.apache.xerces.xni.grammars;
public interface Grammar {
/**
- * get the <code>XMLGrammarDescription</code> associated with this
- * object
+ * Get the <code>XMLGrammarDescription</code> associated with this object.
+ *
+ * @return the <code>XMLGrammarDescription</code> associated with this
object
*/
public XMLGrammarDescription getGrammarDescription ();
} // interface Grammar
diff --git a/src/org/apache/xerces/xni/grammars/XMLGrammarPool.java
b/src/org/apache/xerces/xni/grammars/XMLGrammarPool.java
index 2cdeefaf2..493aa6839 100644
--- a/src/org/apache/xerces/xni/grammars/XMLGrammarPool.java
+++ b/src/org/apache/xerces/xni/grammars/XMLGrammarPool.java
@@ -24,7 +24,7 @@ package org.apache.xerces.xni.grammars;
* assumptions about the kind of Grammar involved, or about how the
* application's storage mechanism works.</p>
*
- * <p>The interaction works as follows:
+ * The interaction works as follows:
* <ul>
* <li>When a validator considers a document, it is expected to request
* grammars of the type it can handle from this object using the
@@ -36,7 +36,7 @@ package org.apache.xerces.xni.grammars;
* instance, the validator should make any new grammars it has compiled
* available to this object using the <code>cacheGrammars</code>
* method; for ease of implementation it may make other Grammars it holds
references to as well (i.e.,
- * it may return some grammars that were retrieved from the GrammarPool in
earlier operations). </li> </ul> </p>
+ * it may return some grammars that were retrieved from the GrammarPool in
earlier operations). </li> </ul>
*
* @author Neil Graham, IBM
* @version $Id$
diff --git a/src/org/apache/xerces/xni/parser/XMLComponent.java
b/src/org/apache/xerces/xni/parser/XMLComponent.java
index c6afd1fd7..293322282 100644
--- a/src/org/apache/xerces/xni/parser/XMLComponent.java
+++ b/src/org/apache/xerces/xni/parser/XMLComponent.java
@@ -46,13 +46,15 @@ public interface XMLComponent {
*
* @throws XNIException Thrown by component on initialization error.
*/
- public void reset(XMLComponentManager componentManager)
+ public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException;
/**
* Returns a list of feature identifiers that are recognized by
* this component. This method may return null if no features
* are recognized by this component.
+ *
+ * @return an array of feature identifiers
*/
public String[] getRecognizedFeatures();
@@ -62,7 +64,8 @@ public interface XMLComponent {
* <p>
* <strong>Note:</strong> Components should silently ignore features
* that do not affect the operation of the component.
- *
+ * </p>
+ *
* @param featureId The feature identifier.
* @param state The state of the feature.
*
@@ -79,6 +82,8 @@ public interface XMLComponent {
* Returns a list of property identifiers that are recognized by
* this component. This method may return null if no properties
* are recognized by this component.
+ *
+ * @return an array of property identifiers
*/
public String[] getRecognizedProperties();
diff --git a/src/org/apache/xerces/xni/parser/XMLComponentManager.java
b/src/org/apache/xerces/xni/parser/XMLComponentManager.java
index 483e6066d..e50184bbd 100644
--- a/src/org/apache/xerces/xni/parser/XMLComponentManager.java
+++ b/src/org/apache/xerces/xni/parser/XMLComponentManager.java
@@ -40,22 +40,24 @@ public interface XMLComponentManager {
/**
* Returns the state of a feature.
+ *
+ * @param featureId The feature identifier
+ *
+ * @return the state of a feature
*
- * @param featureId The feature identifier.
- *
- * @throws XMLConfigurationException Thrown on configuration error.
+ * @throws XMLConfigurationException on configuration error
*/
- public boolean getFeature(String featureId)
- throws XMLConfigurationException;
+ public boolean getFeature(String featureId) throws
XMLConfigurationException;
/**
* Returns the value of a property.
+ *
+ * @param propertyId the property identifier
+ *
+ * @return the value of a property
*
- * @param propertyId The property identifier.
- *
- * @throws XMLConfigurationException Thrown on configuration error.
+ * @throws XMLConfigurationException on configuration error
*/
- public Object getProperty(String propertyId)
- throws XMLConfigurationException;
+ public Object getProperty(String propertyId) throws
XMLConfigurationException;
} // interface XMLComponentManager
diff --git a/src/org/apache/xerces/xni/parser/XMLConfigurationException.java
b/src/org/apache/xerces/xni/parser/XMLConfigurationException.java
index 7e12b3286..a037f78f2 100644
--- a/src/org/apache/xerces/xni/parser/XMLConfigurationException.java
+++ b/src/org/apache/xerces/xni/parser/XMLConfigurationException.java
@@ -97,8 +97,9 @@ public class XMLConfigurationException
//
/**
- * Returns the exception type.
+ * Returns the exception type.
*
+ * @return the exception type
* @see #NOT_RECOGNIZED
* @see #NOT_SUPPORTED
*/
@@ -106,7 +107,11 @@ public class XMLConfigurationException
return fType;
} // getType():short
- /** Returns the feature or property identifier. */
+ /**
+ * Returns the feature or property identifier.
+ *
+ * @return the feature or property identifier
+ */
public String getIdentifier() {
return fIdentifier;
} // getIdentifier():String
diff --git a/src/org/apache/xerces/xni/parser/XMLDTDContentModelSource.java
b/src/org/apache/xerces/xni/parser/XMLDTDContentModelSource.java
index 9dea2c5b2..8ade7c273 100644
--- a/src/org/apache/xerces/xni/parser/XMLDTDContentModelSource.java
+++ b/src/org/apache/xerces/xni/parser/XMLDTDContentModelSource.java
@@ -38,10 +38,18 @@ public interface XMLDTDContentModelSource {
// XMLDTDContentModelSource methods
//
- /** Sets the DTD content model handler. */
+ /**
+ * Sets the DTD content model handler.
+ *
+ * @param handler content model handler
+ */
public void setDTDContentModelHandler(XMLDTDContentModelHandler handler);
- /** Returns the DTD content model handler. */
+ /**
+ * Returns the DTD content model handler.
+ *
+ * @return the DTD content model handler
+ */
public XMLDTDContentModelHandler getDTDContentModelHandler( );
} // interface XMLDTDContentModelSource
diff --git a/src/org/apache/xerces/xni/parser/XMLDocumentScanner.java
b/src/org/apache/xerces/xni/parser/XMLDocumentScanner.java
index 77e26feca..4b96c1130 100644
--- a/src/org/apache/xerces/xni/parser/XMLDocumentScanner.java
+++ b/src/org/apache/xerces/xni/parser/XMLDocumentScanner.java
@@ -65,9 +65,10 @@ public interface XMLDocumentScanner
* permitted to completely scan a document if it does
* not support this "pull" scanning model.
*
- * @return True if there is more to scan, false otherwise.
+ * @return true if there is more to scan, false otherwise
+ * @throws IOException may be thrown by the dispatcher on i/o error
+ * @throws XNIException may be thrown by the dispatcher on parse error
*/
- public boolean scanDocument(boolean complete)
- throws IOException, XNIException;
+ public boolean scanDocument(boolean complete) throws IOException,
XNIException;
} // interface XMLDocumentScanner
diff --git a/src/org/apache/xerces/xni/parser/XMLDocumentSource.java
b/src/org/apache/xerces/xni/parser/XMLDocumentSource.java
index b2ac37d49..8f6f4594f 100644
--- a/src/org/apache/xerces/xni/parser/XMLDocumentSource.java
+++ b/src/org/apache/xerces/xni/parser/XMLDocumentSource.java
@@ -41,7 +41,11 @@ public interface XMLDocumentSource {
/** Sets the document handler. */
public void setDocumentHandler(XMLDocumentHandler handler);
- /** Returns the document handler */
+ /**
+ * Returns the document handler.
+ *
+ * @return the document handler
+ */
public XMLDocumentHandler getDocumentHandler();
} // interface XMLDocumentSource
diff --git a/src/org/apache/xerces/xpointer/ElementSchemePointer.java
b/src/org/apache/xerces/xpointer/ElementSchemePointer.java
index 9701b4fe7..2435af782 100644
--- a/src/org/apache/xerces/xpointer/ElementSchemePointer.java
+++ b/src/org/apache/xerces/xpointer/ElementSchemePointer.java
@@ -559,9 +559,9 @@ final class ElementSchemePointer implements XPointerPart {
}
/**
- * Add the specified string as a token
+ * Add the specified string as a token.
*
- * @param token The token string
+ * @param tokenStr The token string
*/
private void addToken(String tokenStr) {
Integer tokenInt = (Integer) fTokenNames.get(tokenStr);
@@ -573,7 +573,7 @@ final class ElementSchemePointer implements XPointerPart {
}
/**
- * Add the specified int token
+ * Add the specified int token.
*
* @param token The int specifying the token
*/
@@ -607,9 +607,9 @@ final class ElementSchemePointer implements XPointerPart {
/**
* Obtains the token at the current position, then advance
* the current position by one.
- *
+ *
* If there's no such next token, this method throws
- * <tt>new XNIException("InvalidXPointerExpression");</tt>.
+ * <code>new XNIException("InvalidXPointerExpression");</code>.
*/
private int nextToken() throws XNIException {
if (fCurrentTokenIndex == fTokenCount)
@@ -620,9 +620,9 @@ final class ElementSchemePointer implements XPointerPart {
/**
* Obtains the token at the current position, without advancing
* the current position.
- *
+ *
* If there's no such next token, this method throws
- * <tt>new XNIException("InvalidXPointerExpression");</tt>.
+ * <code>new XNIException("InvalidXPointerExpression");</code>.
*/
private int peekToken() throws XNIException {
if (fCurrentTokenIndex == fTokenCount)
@@ -632,11 +632,11 @@ final class ElementSchemePointer implements XPointerPart {
/**
* Obtains the token at the current position as a String.
- *
+ *
* If there's no current token or if the current token
* is not a string token, this method throws
* If there's no such next token, this method throws
- * <tt>new XNIException("InvalidXPointerExpression");</tt>.
+ * <code>new XNIException("InvalidXPointerExpression");</code>.
*/
private String nextTokenAsString() throws XNIException {
String s = getTokenString(nextToken());
diff --git a/src/org/apache/xerces/xpointer/XPointerHandler.java
b/src/org/apache/xerces/xpointer/XPointerHandler.java
index 9725c00f0..f91bcef1a 100644
--- a/src/org/apache/xerces/xpointer/XPointerHandler.java
+++ b/src/org/apache/xerces/xpointer/XPointerHandler.java
@@ -566,7 +566,7 @@ public final class XPointerHandler extends XIncludeHandler
implements
* the current position by one.
*
* throws If there's no such next token, this method throws
- * <tt>new XNIException("XPointerProcessingError");</tt>.
+ * <code>new XNIException("XPointerProcessingError");</code>.
*/
private int nextToken() throws XNIException {
if (fCurrentTokenIndex == fTokenCount) {
@@ -578,9 +578,10 @@ public final class XPointerHandler extends XIncludeHandler
implements
/**
* Obtains the token at the current position, without advancing
* the current position.
- *
+ * <p>
* If there's no such next token, this method throws
- * <tt>new XNIException("XPointerProcessingError");</tt>.
+ * <code>new XNIException("XPointerProcessingError");</code>.
+ * </p>
*/
private int peekToken() throws XNIException {
if (fCurrentTokenIndex == fTokenCount) {
@@ -591,11 +592,12 @@ public final class XPointerHandler extends
XIncludeHandler implements
/**
* Obtains the token at the current position as a String.
- *
+ * <p>
* If there's no current token or if the current token
* is not a string token, this method throws
* If there's no such next token, this method throws
- * <tt>new XNIException("XPointerProcessingError");</tt>.
+ * <code>new XNIException("XPointerProcessingError");</code>.
+ * </p>
*/
private String nextTokenAsString() throws XNIException {
String tokenStrint = getTokenString(nextToken());
diff --git a/src/org/apache/xerces/xs/PSVIProvider.java
b/src/org/apache/xerces/xs/PSVIProvider.java
index 668420e95..271407675 100644
--- a/src/org/apache/xerces/xs/PSVIProvider.java
+++ b/src/org/apache/xerces/xs/PSVIProvider.java
@@ -27,6 +27,7 @@ package org.apache.xerces.xs;
* handling the start and end of an element, applications may use the
* <code>PSVIProvider</code> to retrieve the PSVI related to the element and
* its attributes.
+ * </p>
*/
public interface PSVIProvider {
/**
@@ -66,8 +67,9 @@ public interface PSVIProvider {
* called while in the scope of the document handler's
* <code>startElement</code> call. If the method is called outside of
* the specified scope, the return value is undefined.
- * @param index The attribute index.
- * @return The post schema validation properties of the attribute.
+ *
+ * @param index the attribute index
+ * @return the post-schema validation properties of the attribute
*/
public AttributePSVI getAttributePSVI(int index);
@@ -80,9 +82,10 @@ public interface PSVIProvider {
* SAX the method must be called while in the scope of the document
* handler's <code>startElement</code> call. If the method is called
* outside of the specified scope, the return value is undefined.
- * @param uri The namespace name of an attribute.
- * @param localname The local name of an attribute.
- * @return The post schema validation properties of the attribute.
+ *
+ * @param uri The namespace name of an attribute
+ * @param localname The local name of an attribute
+ * @return The post-schema validation properties of the attribute
*/
public AttributePSVI getAttributePSVIByName(String uri,
String localname);
diff --git a/src/org/apache/xerces/xs/XSComplexTypeDefinition.java
b/src/org/apache/xerces/xs/XSComplexTypeDefinition.java
index 975bd4f17..00bc875dc 100644
--- a/src/org/apache/xerces/xs/XSComplexTypeDefinition.java
+++ b/src/org/apache/xerces/xs/XSComplexTypeDefinition.java
@@ -91,10 +91,9 @@ public interface XSComplexTypeDefinition extends
XSTypeDefinition {
/**
* [prohibited substitutions]: a subset of {extension, restriction}
- * @param restriction Extension or restriction constants (see
- * <code>XSConstants</code>).
- * @return True if <code>restriction</code> is a prohibited substitution,
- * otherwise false.
+ *
+ * @param restriction extension or restriction constants (see
<code>XSConstants</code>)
+ * @return true if <code>restriction</code> is a prohibited substitution,
otherwise false
*/
public boolean isProhibitedSubstitution(short restriction);
diff --git a/src/org/apache/xerces/xs/XSElementDeclaration.java
b/src/org/apache/xerces/xs/XSElementDeclaration.java
index d1d26ccc0..a13a8aad6 100644
--- a/src/org/apache/xerces/xs/XSElementDeclaration.java
+++ b/src/org/apache/xerces/xs/XSElementDeclaration.java
@@ -137,12 +137,12 @@ public interface XSElementDeclaration extends XSTerm {
/**
* Convenience method that checks if <code>exclusion</code> is a
- * substitution group exclusion for this element declaration.
+ * substitution group exclusion for this element declaration.
+ *
* @param exclusion
* <code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code> or
- * <code>DERIVATION_NONE</code>. Represents final set for the element.
- * @return True if <code>exclusion</code> is a part of the substitution
- * group exclusion subset.
+ * <code>DERIVATION_NONE</code>. Represents final set for the element
+ * @return true if <code>exclusion</code> is a part of the substitution
group exclusion subset
*/
public boolean isSubstitutionGroupExclusion(short exclusion);
@@ -156,13 +156,12 @@ public interface XSElementDeclaration extends XSTerm {
/**
* Convenience method that checks if <code>disallowed</code> is a
- * disallowed substitution for this element declaration.
+ * disallowed substitution for this element declaration.
+ *
* @param disallowed {
* <code>DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION,
DERIVATION_RESTRICTION</code>
- * } or <code>DERIVATION_NONE</code>. Represents a block set for the
- * element.
- * @return True if <code>disallowed</code> is a part of the substitution
- * group exclusion subset.
+ * } or <code>DERIVATION_NONE</code>. Represents a block set for the
element
+ * @return true if <code>disallowed</code> is a part of the substitution
group exclusion subset
*/
public boolean isDisallowedSubstitution(short disallowed);
diff --git a/src/org/apache/xerces/xs/XSException.java
b/src/org/apache/xerces/xs/XSException.java
index 9e86770c2..b8c83fb7f 100644
--- a/src/org/apache/xerces/xs/XSException.java
+++ b/src/org/apache/xerces/xs/XSException.java
@@ -22,12 +22,13 @@ package org.apache.xerces.xs;
* circumstances, i.e., when an operation is impossible to perform (either
* for logical reasons, because data is lost, or because the implementation
* has become unstable).
- * <p>Implementations should raise other exceptions under other circumstances.
+ * <p>Implementations should raise other exceptions under other
circumstances.</p>
* <p>Some languages and object systems do not support the concept of
* exceptions. For such systems, error conditions may be indicated using
* native error reporting mechanisms. For some bindings, for example,
* methods may return error codes similar to those listed in the
* corresponding method descriptions.
+ * </p>
*/
public class XSException extends RuntimeException {
diff --git a/src/org/apache/xerces/xs/XSImplementation.java
b/src/org/apache/xerces/xs/XSImplementation.java
index 915f7d9d4..bf22007b2 100644
--- a/src/org/apache/xerces/xs/XSImplementation.java
+++ b/src/org/apache/xerces/xs/XSImplementation.java
@@ -49,15 +49,17 @@ public interface XSImplementation {
/**
* Creates an immutable <code>StringList</code> from the given array of
<code>String</code>s.
- * @param values the array containing the <code>String</code> values that
will be placed in the list.
- * @return an immutable <code>StringList</code> from the given array of
<code>String</code>s.
+ *
+ * @param values the array containing the <code>String</code> values that
will be placed in the list
+ * @return an immutable <code>StringList</code> from the given array of
<code>String</code>s
*/
public StringList createStringList(String[] values);
/**
* Creates an immutable <code>LSInputList</code> from the given array of
<code>LSInput</code>s.
- * @param values the array containing the <code>LSInput</code> values that
will be placed in the list.
- * @return an immutable <code>LSInputList</code> from the given array of
<code>LSInput</code>s.
+ *
+ * @param values the array containing the <code>LSInput</code> values that
will be placed in the list
+ * @return an immutable <code>LSInputList</code> from the given array of
<code>LSInput</code>s
*/
public LSInputList createLSInputList(LSInput[] values);
diff --git a/src/org/apache/xerces/xs/XSLoader.java
b/src/org/apache/xerces/xs/XSLoader.java
index f916fcfc2..d5d40e0f5 100644
--- a/src/org/apache/xerces/xs/XSLoader.java
+++ b/src/org/apache/xerces/xs/XSLoader.java
@@ -54,36 +54,40 @@ public interface XSLoader {
/**
* Parses the content of XML Schema documents specified as the list of URI
* references. If the URI contains a fragment identifier, the behavior
- * is not defined by this specification.
- * @param uriList The list of URI locations.
- * @return An XSModel representing the schema documents.
+ * is not defined by this specification.
+ *
+ * @param uriList the list of URI locations
+ * @return an XSModel representing the schema documents
*/
public XSModel loadURIList(StringList uriList);
/**
* Parses the content of XML Schema documents specified as a list of
- * <code>LSInput</code>s.
- * @param is The list of <code>LSInput</code>s from which the XML
+ * <code>LSInput</code>s.
+ *
+ * @param is the list of <code>LSInput</code>s from which the XML
* Schema documents are to be read.
- * @return An XSModel representing the schema documents.
+ * @return an {@link XSModel} representing the schema documents
*/
public XSModel loadInputList(LSInputList is);
/**
* Parse an XML Schema document from a location identified by a URI
* reference. If the URI contains a fragment identifier, the behavior is
- * not defined by this specification.
- * @param uri The location of the XML Schema document to be read.
- * @return An XSModel representing this schema.
+ * not defined by this specification.
+ *
+ * @param uri the location of the XML Schema document to be read
+ * @return an {@link XSModel} representing this schema
*/
public XSModel loadURI(String uri);
/**
* Parse an XML Schema document from a resource identified by a
- * <code>LSInput</code> .
- * @param is The <code>LSInput</code> from which the source
- * document is to be read.
- * @return An XSModel representing this schema.
+ * <code>LSInput</code>.
+ *
+ * @param is the <code>LSInput</code> from which the source document is
+ * to be read.
+ * @return an {@link XSModel} representing this schema.
*/
public XSModel load(LSInput is);
diff --git a/src/org/apache/xerces/xs/XSModel.java
b/src/org/apache/xerces/xs/XSModel.java
index 588893291..e09545d5b 100644
--- a/src/org/apache/xerces/xs/XSModel.java
+++ b/src/org/apache/xerces/xs/XSModel.java
@@ -44,15 +44,15 @@ public interface XSModel {
* attribute declarations, etc. Identity-constraint definitions are also
* considered top-level.
*
- * @param objectType The type of the declaration, i.e.
+ * @param objectType the type of the declaration, i.e.
* <code>ELEMENT_DECLARATION</code>. Note that
* <code>XSTypeDefinition.SIMPLE_TYPE</code> and
* <code>XSTypeDefinition.COMPLEX_TYPE</code> can also be used as the
* <code>objectType</code> to retrieve only complex types or simple
- * types, instead of all types.
- * @return A list of top-level definitions of the specified type in
+ * types, instead of all types
+ * @return a list of top-level definitions of the specified type in
* <code>objectType</code> or an empty <code>XSNamedMap</code> if no
- * such definitions exist.
+ * such definitions exist
*/
public XSNamedMap getComponents(short objectType);
@@ -62,13 +62,12 @@ public interface XSModel {
* declarations, attribute declarations, etc. Identity-constraint
* definitions are also considered top-level.
*
- * @param objectType The type of the declaration, i.e.
- * <code>ELEMENT_DECLARATION</code>.
- * @param namespace The namespace to which the declaration belongs or
- * <code>null</code> (for components with no target namespace).
- * @return A list of top-level definitions of the specified type in
+ * @param objectType the type of the declaration, i.e.
<code>ELEMENT_DECLARATION</code>
+ * @param namespace the namespace to which the declaration belongs or
+ * <code>null</code> (for components with no target namespace)
+ * @return a collection of top-level definitions of the specified type in
* <code>objectType</code> and defined in the specified
- * <code>namespace</code> or an empty <code>XSNamedMap</code>.
+ * <code>namespace</code> or an empty <code>XSNamedMap</code>
*/
public XSNamedMap getComponentsByNamespace(short objectType,
String namespace);
@@ -82,77 +81,77 @@ public interface XSModel {
/**
* Convenience method. Returns a top-level element declaration.
* @param name The name of the declaration.
- * @param namespace The namespace of the declaration, otherwise
- * <code>null</code>.
- * @return A top-level element declaration or <code>null</code> if such a
- * declaration does not exist.
+ *
+ * @param namespace the namespace of the declaration, otherwise
+ * <code>null</code>
+ * @return a top-level element declaration or <code>null</code> if such a
+ * declaration does not exist
*/
public XSElementDeclaration getElementDeclaration(String name,
String namespace);
/**
- * Convenience method. Returns a top-level attribute declaration.
- * @param name The name of the declaration.
- * @param namespace The namespace of the declaration, otherwise
- * <code>null</code>.
- * @return A top-level attribute declaration or <code>null</code> if such
- * a declaration does not exist.
+ * Convenience method. Returns a top-level attribute declaration.
+ *
+ * @param name the name of the declaration
+ * @param namespace the namespace of the declaration, otherwise
<code>null</code>
+ * @return a top-level attribute declaration or <code>null</code> if such
+ * a declaration does not exist
*/
public XSAttributeDeclaration getAttributeDeclaration(String name,
String namespace);
/**
- * Convenience method. Returns a top-level simple or complex type
- * definition.
- * @param name The name of the definition.
- * @param namespace The namespace of the declaration, otherwise
- * <code>null</code>.
- * @return An <code>XSTypeDefinition</code> or <code>null</code> if such
- * a definition does not exist.
+ * Convenience method. Returns a top-level simple or complex type
definition.
+ *
+ * @param name the name of the definition
+ * @param namespace the namespace of the declaration, otherwise
<code>null</code>
+ * @return an <code>XSTypeDefinition</code> or <code>null</code> if such
+ * a definition does not exist
*/
public XSTypeDefinition getTypeDefinition(String name,
String namespace);
/**
- * Convenience method. Returns a top-level attribute group definition.
- * @param name The name of the definition.
- * @param namespace The namespace of the definition, otherwise
- * <code>null</code>.
- * @return A top-level attribute group definition or <code>null</code> if
- * such a definition does not exist.
+ * Convenience method. Returns a top-level attribute group definition.
+ *
+ * @param name the name of the definition
+ * @param namespace the namespace of the definition, otherwise
<code>null</code>
+ * @return a top-level attribute group definition or <code>null</code> if
+ * such a definition does not exist
*/
public XSAttributeGroupDefinition getAttributeGroup(String name,
String namespace);
/**
- * Convenience method. Returns a top-level model group definition.
- * @param name The name of the definition.
- * @param namespace The namespace of the definition, otherwise
- * <code>null</code>.
- * @return A top-level model group definition or <code>null</code> if
- * such a definition does not exist.
+ * Convenience method. Returns a top-level model group definition.
+ *
+ * @param name the name of the definition
+ * @param namespace the namespace of the definition, otherwise
<code>null</code>
+ * @return a top-level model group definition or <code>null</code> if
+ * such a definition does not exist
*/
public XSModelGroupDefinition getModelGroupDefinition(String name,
String namespace);
/**
- * Convenience method. Returns a top-level notation declaration.
- * @param name The name of the declaration.
- * @param namespace The namespace of the declaration, otherwise
- * <code>null</code>.
- * @return A top-level notation declaration or <code>null</code> if such
- * a declaration does not exist.
+ * Convenience method. Returns a top-level notation declaration.
+ *
+ * @param name the name of the declaration
+ * @param namespace the namespace of the declaration, otherwise
<code>null</code>
+ * @return a top-level notation declaration or <code>null</code> if such
+ * a declaration does not exist
*/
public XSNotationDeclaration getNotationDeclaration(String name,
String namespace);
/**
* Convenience method. Returns an identity-constraint definition.
- * @param name The name of the definition.
- * @param namespace The namespace of the definition, otherwise
- * <code>null</code>.
- * @return An identity-constraint definition or <code>null</code> if such
- * a declaration does not exist.
+ *
+ * @param name the name of the definition
+ * @param namespace the namespace of the definition, otherwise
<code>null</code>
+ * @return an identity-constraint definition or <code>null</code> if such
+ * a declaration does not exist
*/
public XSIDCDefinition getIDCDefinition(String name,
String namespace);
@@ -162,11 +161,12 @@ public interface XSModel {
* substitution group for the given <code>XSElementDeclaration</code>
* or an empty <code>XSObjectList</code> if the substitution group
* contains no members.
- * @param head The substitution group head.
- * @return A list containing the members of the substitution group
+ *
+ * @param head the substitution group head
+ * @return a list containing the members of the substitution group
* for the given <code>XSElementDeclaration</code> or an empty
* <code>XSObjectList</code> if the substitution group contains
- * no members.
+ * no members
*/
public XSObjectList getSubstitutionGroup(XSElementDeclaration head);
diff --git a/src/org/apache/xerces/xs/datatypes/XSDateTime.java
b/src/org/apache/xerces/xs/datatypes/XSDateTime.java
index 4359b4ebb..6e0a07105 100644
--- a/src/org/apache/xerces/xs/datatypes/XSDateTime.java
+++ b/src/org/apache/xerces/xs/datatypes/XSDateTime.java
@@ -20,13 +20,12 @@ import javax.xml.datatype.Duration;
import javax.xml.datatype.XMLGregorianCalendar;
/**
- * <p>Interface to expose the values for all date-time related types. The
following
+ * Interface to expose the values for all date-time related types. The
following
* table shows the methods defined for various XML Schema 1.0 built-in types.
'X'
* marks whether a particular method is defined for a particular type.
Accessing undefined
* methods may return unexpected values.
*
* <table border="1">
- * <br/>
* <tr>
* <td> XML Schema Datatype </td>
* <td> getYears() </td>
@@ -198,7 +197,6 @@ import javax.xml.datatype.XMLGregorianCalendar;
* <td>X</td>
* </tr>
* </table>
- * </p>
*
* @author Ankit Pasricha, IBM
*
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
