mrglavas 2004/03/24 20:03:23
Modified: java/src/org/apache/xerces/util XMLChar.java
XMLGrammarPoolImpl.java XML11Char.java
XMLAttributesImpl.java
java/src/org/apache/xerces/impl/xs/opti
DefaultXMLDocumentHandler.java
SchemaParsingConfig.java
java/src/org/apache/xerces/impl/xs/identity ValueStore.java
XPathMatcher.java Selector.java
java/src/org/apache/xerces/parsers DTDParser.java
XMLGrammarPreparser.java
BasicParserConfiguration.java
AbstractSAXParser.java
XMLGrammarCachingConfiguration.java DOMParser.java
java/src/org/apache/xerces/impl/xs/traversers
XSAttributeChecker.java
java/src/org/apache/xerces/impl/xs XSDDescription.java
XMLSchemaValidator.java
java/src/org/apache/xerces/impl/xs/models XSAllCM.java
Log:
Fixing many javadoc warnings.
Revision Changes Path
1.16 +2 -2 xml-xerces/java/src/org/apache/xerces/util/XMLChar.java
Index: XMLChar.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/util/XMLChar.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- XMLChar.java 24 Feb 2004 23:15:53 -0000 1.15
+++ XMLChar.java 25 Mar 2004 04:03:22 -0000 1.16
@@ -917,7 +917,7 @@
* Check to see if a string is a valid NCName according to [4]
* from the XML Namespaces 1.0 Recommendation
*
- * @param name string to check
+ * @param ncName string to check
* @return true if name is a valid NCName
*/
public static boolean isValidNCName(String ncName) {
1.8 +4 -4
xml-xerces/java/src/org/apache/xerces/util/XMLGrammarPoolImpl.java
Index: XMLGrammarPoolImpl.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/util/XMLGrammarPoolImpl.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- XMLGrammarPoolImpl.java 24 Feb 2004 23:15:53 -0000 1.7
+++ XMLGrammarPoolImpl.java 25 Mar 2004 04:03:22 -0000 1.8
@@ -290,9 +290,9 @@
* the root element names for DTD grammars and the target namespaces for Schema
grammars.
* The application can override this behaviour and add its own logic.
*
- * @param gDesc1 The grammar description
- * @param gDesc2 The grammar description of the grammar to be compared to
- * @return True if the grammars are equal, otherwise false
+ * @param desc1 The grammar description
+ * @param desc2 The grammar description of the grammar to be compared to
+ * @return True if the grammars are equal, otherwise false
*/
public boolean equals(XMLGrammarDescription desc1, XMLGrammarDescription desc2)
{
return desc1.equals(desc2);
1.8 +2 -2 xml-xerces/java/src/org/apache/xerces/util/XML11Char.java
Index: XML11Char.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/util/XML11Char.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- XML11Char.java 24 Feb 2004 23:15:53 -0000 1.7
+++ XML11Char.java 25 Mar 2004 04:03:22 -0000 1.8
@@ -333,7 +333,7 @@
* Check to see if a string is a valid NCName according to [4]
* from the XML Namespaces 1.1 Recommendation
*
- * @param name string to check
+ * @param ncName string to check
* @return true if name is a valid NCName
*/
public static boolean isXML11ValidNCName(String ncName) {
1.26 +4 -4
xml-xerces/java/src/org/apache/xerces/util/XMLAttributesImpl.java
Index: XMLAttributesImpl.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/util/XMLAttributesImpl.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- XMLAttributesImpl.java 24 Feb 2004 23:15:53 -0000 1.25
+++ XMLAttributesImpl.java 25 Mar 2004 04:03:22 -0000 1.26
@@ -515,7 +515,7 @@
* <p>If the attribute name has a namespace prefix, the prefix
* will still be attached.</p>
*
- * @param i The index of the attribute in the list (starting at 0).
+ * @param index The index of the attribute in the list (starting at 0).
* @return The name of the indexed attribute, or null
* if the index is out of range.
* @see #getLength
@@ -554,7 +554,7 @@
*
* @param uri The Namespace URI, or null if
* the name has no Namespace URI.
- * @param localName The attribute's local name.
+ * @param localPart The attribute's local name.
* @return The index of the attribute, or -1 if it does not
* appear in the list.
*/
@@ -914,7 +914,7 @@
*
* @param uri The Namespace URI, or null if
* the name has no Namespace URI.
- * @param localName The attribute's local name.
+ * @param localPart The attribute's local name.
* @return The index of the attribute, or -1 if it does not
* appear in the list.
*/
1.4 +2 -2
xml-xerces/java/src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java
Index: DefaultXMLDocumentHandler.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- DefaultXMLDocumentHandler.java 24 Feb 2004 22:59:11 -0000 1.3
+++ DefaultXMLDocumentHandler.java 25 Mar 2004 04:03:22 -0000 1.4
@@ -420,7 +420,7 @@
* @exception XNIException
* Thrown by handler to signal an error.
*/
- public void startExternalSubset(XMLResourceIdentifier ri,
+ public void startExternalSubset(XMLResourceIdentifier identifier,
Augmentations augmentations)
throws XNIException {
}
1.7 +2 -2
xml-xerces/java/src/org/apache/xerces/impl/xs/opti/SchemaParsingConfig.java
Index: SchemaParsingConfig.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/opti/SchemaParsingConfig.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SchemaParsingConfig.java 24 Feb 2004 22:59:11 -0000 1.6
+++ SchemaParsingConfig.java 25 Mar 2004 04:03:22 -0000 1.7
@@ -381,7 +381,7 @@
* @param complete True if the pull parser should parse the
* remaining document completely.
*
- * @returns True if there is more document to parse.
+ * @return True if there is more document to parse.
*
* @exception XNIException Any XNI exception, possibly wrapping
* another exception.
1.7 +2 -2
xml-xerces/java/src/org/apache/xerces/impl/xs/identity/ValueStore.java
Index: ValueStore.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/identity/ValueStore.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ValueStore.java 24 Feb 2004 22:59:14 -0000 1.6
+++ ValueStore.java 25 Mar 2004 04:03:22 -0000 1.7
@@ -47,7 +47,7 @@
* @param field The field associated to the value. This reference
* is used to ensure that each field only adds a value
* once within a selection scope.
- * @param value The value to add.
+ * @param actualValue The value to add.
*/
public void addValue(Field field, Object actualValue);
1.24 +2 -6
xml-xerces/java/src/org/apache/xerces/impl/xs/identity/XPathMatcher.java
Index: XPathMatcher.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/identity/XPathMatcher.java,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- XPathMatcher.java 24 Feb 2004 22:59:14 -0000 1.23
+++ XPathMatcher.java 25 Mar 2004 04:03:22 -0000 1.24
@@ -169,9 +169,6 @@
/**
* The start of the document fragment.
- *
- * @param context The namespace scope in effect at the
- * start of this document fragment.
*/
public void startDocumentFragment(){
if (DEBUG_METHODS) {
@@ -189,7 +186,7 @@
}
- } // startDocumentFragment(SymbolTable)
+ } // startDocumentFragment()
/**
* The start of an element. If the document specifies the start element
@@ -198,7 +195,6 @@
*
* @param element The name of the element.
* @param attributes The element attributes.
- * @param type: The element's type
*
* @throws SAXException Thrown by handler to signal an error.
*/
1.18 +3 -4
xml-xerces/java/src/org/apache/xerces/impl/xs/identity/Selector.java
Index: Selector.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/identity/Selector.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- Selector.java 24 Feb 2004 22:59:14 -0000 1.17
+++ Selector.java 25 Mar 2004 04:03:22 -0000 1.18
@@ -201,8 +201,7 @@
* be followed by the endElement method, with no intervening methods.
*
* @param element The name of the element.
- * @param attributes The element attributes.
- * @param elementDecl: The element declaration
+ * @param attributes The element attributes.
*
*/
public void startElement(QName element, XMLAttributes attributes) {
1.12 +17 -15 xml-xerces/java/src/org/apache/xerces/parsers/DTDParser.java
Index: DTDParser.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/parsers/DTDParser.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- DTDParser.java 24 Feb 2004 23:15:56 -0000 1.11
+++ DTDParser.java 25 Mar 2004 04:03:23 -0000 1.12
@@ -252,13 +252,14 @@
/**
* An external entity declaration.
- *
+ *
* @param name The name of the entity. Parameter entity names start
* with '%', whereas the name of a general entity is just
* the entity name.
- * @param publicId The public identifier of the entity or null if the
- * the entity was specified with SYSTEM.
- * @param systemId The system identifier of the entity.
+ * @param identifier An object containing all location information
+ * pertinent to this entity.
+ * @param augmentations Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -270,14 +271,15 @@
/**
* An unparsed entity declaration.
- *
+ *
* @param name The name of the entity.
- * @param publicId The public identifier of the entity, or null if not
- * specified.
- * @param systemId The system identifier of the entity, or null if not
- * specified.
+ * @param identifier An object containing all location information
+ * pertinent to this entity.
* @param notation The name of the notation.
*
+ * @param augmentations Additional information that may include infoset
+ * augmentations.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void unparsedEntityDecl(String name,
@@ -288,12 +290,12 @@
/**
* A notation declaration
- *
+ *
* @param name The name of the notation.
- * @param publicId The public identifier of the notation, or null if not
- * specified.
- * @param systemId The system identifier of the notation, or null if not
- * specified.
+ * @param identifier An object containing all location information
+ * pertinent to this notation.
+ * @param augmentations Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
1.10 +2 -2
xml-xerces/java/src/org/apache/xerces/parsers/XMLGrammarPreparser.java
Index: XMLGrammarPreparser.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/parsers/XMLGrammarPreparser.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- XMLGrammarPreparser.java 24 Feb 2004 23:15:56 -0000 1.9
+++ XMLGrammarPreparser.java 25 Mar 2004 04:03:23 -0000 1.10
@@ -173,7 +173,7 @@
* This method also adds this grammar to the XMLGrammarPool
*
* @param type The type of the grammar to be constructed
- * @param source The XMLInputSource containing this grammar's
+ * @param is The XMLInputSource containing this grammar's
* information
* <strong>If a URI is included in the systemId field, the parser will not
expand this URI or make it
* available to the EntityResolver</strong>
1.23 +2 -2
xml-xerces/java/src/org/apache/xerces/parsers/BasicParserConfiguration.java
Index: BasicParserConfiguration.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/parsers/BasicParserConfiguration.java,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- BasicParserConfiguration.java 24 Feb 2004 23:15:56 -0000 1.22
+++ BasicParserConfiguration.java 25 Mar 2004 04:03:23 -0000 1.23
@@ -302,7 +302,7 @@
* has ended. If a client application wants to terminate
* parsing early, it should throw an exception.
*
- * @param source The input source for the top-level of the
+ * @param inputSource The input source for the top-level of the
* XML document.
*
* @exception XNIException Any XNI exception, possibly wrapping
1.53 +3 -3
xml-xerces/java/src/org/apache/xerces/parsers/AbstractSAXParser.java
Index: AbstractSAXParser.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/parsers/AbstractSAXParser.java,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -r1.52 -r1.53
--- AbstractSAXParser.java 19 Mar 2004 23:18:33 -0000 1.52
+++ AbstractSAXParser.java 25 Mar 2004 04:03:23 -0000 1.53
@@ -1094,7 +1094,7 @@
* parse(new InputSource(systemId));
* </pre>
*
- * @param source The input source.
+ * @param systemId The system identifier (URI).
*
* @exception org.xml.sax.SAXException Throws exception on SAX error.
* @exception java.io.IOException Throws exception on i/o error.
@@ -1634,7 +1634,7 @@
*
* @param propertyId The unique identifier (URI) of the property
* being set.
- * @param Object The value to which the property is being set.
+ * @param value The value to which the property is being set.
*
* @exception SAXNotRecognizedException If the
* requested property is not known.
1.17 +2 -2
xml-xerces/java/src/org/apache/xerces/parsers/XMLGrammarCachingConfiguration.java
Index: XMLGrammarCachingConfiguration.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/parsers/XMLGrammarCachingConfiguration.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- XMLGrammarCachingConfiguration.java 24 Feb 2004 23:15:56 -0000 1.16
+++ XMLGrammarCachingConfiguration.java 25 Mar 2004 04:03:23 -0000 1.17
@@ -213,7 +213,7 @@
* This method also adds this grammar to the XMLGrammarPool
*
* @param type The type of the grammar to be constructed
- * @param source The XMLInputSource containing this grammar's
+ * @param is The XMLInputSource containing this grammar's
* information
* <strong>If a URI is included in the systemId field, the parser will not
expand this URI or make it
* available to the EntityResolver</strong>
1.71 +3 -3 xml-xerces/java/src/org/apache/xerces/parsers/DOMParser.java
Index: DOMParser.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/parsers/DOMParser.java,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -r1.70 -r1.71
--- DOMParser.java 24 Feb 2004 23:15:56 -0000 1.70
+++ DOMParser.java 25 Mar 2004 04:03:23 -0000 1.71
@@ -132,7 +132,7 @@
* parse(new InputSource(systemId));
* </pre>
*
- * @param source The input source.
+ * @param systemId The system identifier (URI).
*
* @exception org.xml.sax.SAXException Throws exception on SAX error.
* @exception java.io.IOException Throws exception on i/o error.
@@ -415,7 +415,7 @@
*
* @param propertyId The unique identifier (URI) of the property
* being set.
- * @param Object The value to which the property is being set.
+ * @param value The value to which the property is being set.
*
* @exception SAXNotRecognizedException If the
* requested property is not known.
1.32 +5 -5
xml-xerces/java/src/org/apache/xerces/impl/xs/traversers/XSAttributeChecker.java
Index: XSAttributeChecker.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/traversers/XSAttributeChecker.java,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- XSAttributeChecker.java 24 Feb 2004 22:59:14 -0000 1.31
+++ XSAttributeChecker.java 25 Mar 2004 04:03:23 -0000 1.32
@@ -992,10 +992,10 @@
* copy of the namespace context, so that the value can be resolved as a
* QName later.
*
- * @param element - which element to check
- * @param isGlobal - whether a child of <schema> or <redefine>
- * @param schemaDoc - the document where the element lives in
- * @param enumAsQName- whether to tread enumeration value as QName
+ * @param element which element to check
+ * @param isGlobal whether a child of <schema> or <redefine>
+ * @param schemaDoc the document where the element lives in
+ * @param enumAsQName whether to tread enumeration value as QName
* @return an array containing attribute values
*/
public Object[] checkAttributes(Element element, boolean isGlobal,
1.11 +3 -3
xml-xerces/java/src/org/apache/xerces/impl/xs/XSDDescription.java
Index: XSDDescription.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/XSDDescription.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- XSDDescription.java 24 Feb 2004 22:59:11 -0000 1.10
+++ XSDDescription.java 25 Mar 2004 04:03:23 -0000 1.11
@@ -179,8 +179,8 @@
* Compares this grammar with the given grammar. Currently, we compare
* the target namespaces.
*
- * @param desc The description of the grammar to be compared with
- * @return True if they are equal, else false
+ * @param descObj The description of the grammar to be compared with
+ * @return True if they are equal, else false
*/
public boolean equals(Object descObj) {
if(!(descObj instanceof XMLSchemaDescription)) return false;
1.155 +2 -6
xml-xerces/java/src/org/apache/xerces/impl/xs/XMLSchemaValidator.java
Index: XMLSchemaValidator.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/XMLSchemaValidator.java,v
retrieving revision 1.154
retrieving revision 1.155
diff -u -r1.154 -r1.155
--- XMLSchemaValidator.java 11 Mar 2004 16:10:46 -0000 1.154
+++ XMLSchemaValidator.java 25 Mar 2004 04:03:23 -0000 1.155
@@ -3360,10 +3360,10 @@
/**
* Adds the specified value to the value store.
*
- * @param value The value to add.
* @param field The field associated to the value. This reference
* is used to ensure that each field only adds a value
* once within a selection scope.
+ * @param actualValue The value to add.
*/
public void addValue(Field field, Object actualValue) {
int i;
@@ -3502,8 +3502,6 @@
/**
* Called when a duplicate value is added.
- *
- * @param tuple The duplicate value tuple.
*/
protected void checkDuplicateValues() {
// is this value as a group duplicated?
@@ -3541,8 +3539,6 @@
/**
* Called when a duplicate value is added.
- *
- * @param tuple The duplicate value tuple.
*/
protected void checkDuplicateValues() {
if (contains()) {
1.10 +3 -3
xml-xerces/java/src/org/apache/xerces/impl/xs/models/XSAllCM.java
Index: XSAllCM.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/models/XSAllCM.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- XSAllCM.java 24 Feb 2004 22:59:13 -0000 1.9
+++ XSAllCM.java 25 Mar 2004 04:03:23 -0000 1.10
@@ -105,7 +105,7 @@
* The method corresponds to one transition in the content model.
*
* @param elementName
- * @param state Current state
+ * @param currentState Current state
* @return an element decl object
*/
public Object oneTransition (QName elementName, int[] currentState,
SubstitutionGroupHandler subGroupHandler) {
@@ -143,7 +143,7 @@
/**
* The method indicates the end of list of children
*
- * @param state Current state of the content model
+ * @param currentState Current state of the content model
* @return true if the last state was a valid final state
*/
public boolean endContentModel (int[] currentState) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
