You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by mr...@apache.org on 2006/09/24 23:11:29 UTC

svn commit: r449487 - in /xerces/java/trunk/src/org/apache: html/dom/ xerces/impl/dv/xs/ xerces/impl/xs/ xerces/impl/xs/traversers/ xerces/impl/xs/util/ xerces/jaxp/datatype/ xerces/parsers/ xerces/util/ xerces/xinclude/ xerces/xpointer/ xerces/xs/ xml...

Author: mrglavas
Date: Sun Sep 24 14:11:28 2006
New Revision: 449487

URL: http://svn.apache.org/viewvc?view=rev&rev=449487
Log:
Various fixes for Javadoc warnings.

Modified:
    xerces/java/trunk/src/org/apache/html/dom/HTMLDocumentImpl.java
    xerces/java/trunk/src/org/apache/xerces/impl/dv/xs/AbstractDateTimeDV.java
    xerces/java/trunk/src/org/apache/xerces/impl/xs/XMLSchemaLoader.java
    xerces/java/trunk/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java
    xerces/java/trunk/src/org/apache/xerces/impl/xs/XSLoaderImpl.java
    xerces/java/trunk/src/org/apache/xerces/impl/xs/traversers/XSDHandler.java
    xerces/java/trunk/src/org/apache/xerces/impl/xs/util/SimpleLocator.java
    xerces/java/trunk/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java
    xerces/java/trunk/src/org/apache/xerces/parsers/DOMParserImpl.java
    xerces/java/trunk/src/org/apache/xerces/util/AttributesProxy.java
    xerces/java/trunk/src/org/apache/xerces/xinclude/XIncludeHandler.java
    xerces/java/trunk/src/org/apache/xerces/xpointer/XPointerPart.java
    xerces/java/trunk/src/org/apache/xerces/xs/XSLoader.java
    xerces/java/trunk/src/org/apache/xml/serialize/BaseMarkupSerializer.java
    xerces/java/trunk/src/org/apache/xml/serialize/XML11Serializer.java
    xerces/java/trunk/src/org/apache/xml/serialize/XMLSerializer.java

Modified: xerces/java/trunk/src/org/apache/html/dom/HTMLDocumentImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/html/dom/HTMLDocumentImpl.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/html/dom/HTMLDocumentImpl.java (original)
+++ xerces/java/trunk/src/org/apache/html/dom/HTMLDocumentImpl.java Sun Sep 24 14:11:28 2006
@@ -66,35 +66,35 @@
     private static final long serialVersionUID = 4285791750126227180L;
 
     /**
-     * Holds {@link HTMLCollectionImpl} object with live collection of all
+     * Holds <code>HTMLCollectionImpl</code> object with live collection of all
      * anchors in document. This reference is on demand only once.
      */
     private HTMLCollectionImpl    _anchors;
 
 
     /**
-     * Holds {@link HTMLCollectionImpl} object with live collection of all
+     * Holds <code>HTMLCollectionImpl</code> object with live collection of all
      * forms in document. This reference is on demand only once.
      */
     private HTMLCollectionImpl    _forms;
 
 
     /**
-     * Holds {@link HTMLCollectionImpl} object with live collection of all
+     * Holds <code>HTMLCollectionImpl</code> object with live collection of all
      * images in document. This reference is on demand only once.
      */
     private HTMLCollectionImpl    _images;
 
 
     /**
-     * Holds {@link HTMLCollectionImpl} object with live collection of all
+     * Holds <code>HTMLCollectionImpl</code> object with live collection of all
      * links in document. This reference is on demand only once.
      */
     private HTMLCollectionImpl    _links;
 
 
     /**
-     * Holds {@link HTMLCollectionImpl} object with live collection of all
+     * Holds <code>HTMLCollectionImpl</code> object with live collection of all
      * applets in document. This reference is on demand only once.
      */
     private HTMLCollectionImpl    _applets;
@@ -433,7 +433,7 @@
      *                     create.
      * @param qualifiedName The qualified name of the element type to
      *                      instantiate.
-     * @param localName     The local name of the element to instantiate.
+     * @param localpart     The local name of the element to instantiate.
      * @return Element A new Element object with the following attributes:
      * @throws DOMException INVALID_CHARACTER_ERR: Raised if the specified
      *                      name contains an invalid character.

Modified: xerces/java/trunk/src/org/apache/xerces/impl/dv/xs/AbstractDateTimeDV.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/impl/dv/xs/AbstractDateTimeDV.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/impl/dv/xs/AbstractDateTimeDV.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/impl/dv/xs/AbstractDateTimeDV.java Sun Sep 24 14:11:28 2006
@@ -577,7 +577,6 @@
 	 * If timezone present - normalize dateTime  [E Adding durations to dateTimes]
 	 *
 	 * @param date   CCYY-MM-DDThh:mm:ss+03
-	 * @return CCYY-MM-DDThh:mm:ssZ
 	 */
 	protected void normalize(DateTimeData date) {
 		

Modified: xerces/java/trunk/src/org/apache/xerces/impl/xs/XMLSchemaLoader.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/impl/xs/XMLSchemaLoader.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/impl/xs/XMLSchemaLoader.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/impl/xs/XMLSchemaLoader.java Sun Sep 24 14:11:28 2006
@@ -89,7 +89,6 @@
  * @author Neil Graham, IBM
  * @version $Id$
  */
-
 public class XMLSchemaLoader implements XMLGrammarLoader, XMLComponent,
 // XML Component API 
 XSLoader, DOMConfiguration {
@@ -205,7 +204,6 @@
     
     // features and properties
     private ParserConfigurationSettings fLoaderConfig = new ParserConfigurationSettings();
-    private SymbolTable fSymbolTable = null;
     private XMLErrorReporter fErrorReporter = new XMLErrorReporter ();
     private XMLEntityManager fEntityManager = null;
     private XMLEntityResolver fUserEntityResolver = null;
@@ -474,7 +472,7 @@
      * Returns a Grammar object by parsing the contents of the
      * entities pointed to by sources.
      * 
-     * @param source[]  the locations of the entity which forms 
+     * @param source the locations of the entity which forms 
      *                      the staring point of the grammars to be constructed
      * @throws IOException  when a problem is encounted reading the entity
      * @throws XNIException when a condition arises (such as a FatalError) that requires parsing
@@ -556,7 +554,8 @@
         return grammar;
     } // loadSchema(XSDDescription, XMLInputSource):  SchemaGrammar
     
-    /** This method tries to resolve location of the given schema.
+    /** 
+     * This method tries to resolve location of the given schema.
      * The loader stores the namespace/location pairs in a hashtable (use "" as the
      * namespace of absent namespace). When resolving an entity, loader first tries
      * to find in the hashtable whether there is a value for that namespace,
@@ -565,7 +564,7 @@
      * @param desc
      * @param locationPairs
      * @param entityResolver
-     * @return
+     * @return the XMLInputSource
      * @throws IOException
      */
     public static XMLInputSource resolveDocument(XSDDescription desc, Hashtable locationPairs,

Modified: xerces/java/trunk/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/impl/xs/XSComplexTypeDecl.java Sun Sep 24 14:11:28 2006
@@ -241,7 +241,7 @@
      *            The namspace of the ancestor type declaration
      * @param ancestorName
      *            The name of the ancestor type declaration
-     * @param derivation
+     * @param derivationMethod
      *            The derivation method
      * 
      * @return boolean True if the ancestor type is derived from the reference

Modified: xerces/java/trunk/src/org/apache/xerces/impl/xs/XSLoaderImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/impl/xs/XSLoaderImpl.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/impl/xs/XSLoaderImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/impl/xs/XSLoaderImpl.java Sun Sep 24 14:11:28 2006
@@ -95,7 +95,7 @@
      * 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 uri The list of URI locations.
+     * @param uriList The list of URI locations.
      * @return An XSModel representing the schema documents.
      */
     public XSModel loadURIList(StringList uriList) {

Modified: xerces/java/trunk/src/org/apache/xerces/impl/xs/traversers/XSDHandler.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/impl/xs/traversers/XSDHandler.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/impl/xs/traversers/XSDHandler.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/impl/xs/traversers/XSDHandler.java Sun Sep 24 14:11:28 2006
@@ -405,7 +405,7 @@
      * @param is
      * @param desc
      * @param locationPairs
-     * @return
+     * @return the SchemaGrammar
      * @throws IOException
      */
     public SchemaGrammar parseSchema(XMLInputSource is, XSDDescription desc,

Modified: xerces/java/trunk/src/org/apache/xerces/impl/xs/util/SimpleLocator.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/impl/xs/util/SimpleLocator.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/impl/xs/util/SimpleLocator.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/impl/xs/util/SimpleLocator.java Sun Sep 24 14:11:28 2006
@@ -87,16 +87,11 @@
     public String getBaseSystemId() {
         return null;
     }
-    /**
-     * @see org.apache.xerces.xni.XMLLocator#setColumnNumber(int)
-     */
+
     public void setColumnNumber(int col) {
         this.column = col;
     }
     
-    /**
-     * @see org.apache.xerces.xni.XMLLocator#setLineNumber(int)
-     */
     public void setLineNumber(int line) {
         this.line = line;
     }
@@ -129,7 +124,8 @@
      */
     public void setPublicId(String publicId) {}
     
-    /** Returns the encoding of the current entity.  
+    /** 
+     * Returns the encoding of the current entity.  
      * Since these locators are used in the construction of
      * XMLParseExceptions, which know nothing about encodings, there is
      * no point in having this object deal intelligently 

Modified: xerces/java/trunk/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java Sun Sep 24 14:11:28 2006
@@ -17,10 +17,11 @@
 
 package org.apache.xerces.jaxp.datatype;
 
-import java.math.BigInteger;
 import java.math.BigDecimal;
+import java.math.BigInteger;
 import java.util.GregorianCalendar;
 
+import javax.xml.datatype.DatatypeConfigurationException;
 import javax.xml.datatype.DatatypeConstants;
 import javax.xml.datatype.DatatypeFactory;
 import javax.xml.datatype.Duration;

Modified: xerces/java/trunk/src/org/apache/xerces/parsers/DOMParserImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/parsers/DOMParserImpl.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/parsers/DOMParserImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/parsers/DOMParserImpl.java Sun Sep 24 14:11:28 2006
@@ -1054,7 +1054,7 @@
     }
 
     /**
-     * @see org.w3c.dom.ls.DOMParser#abort()
+     * @see org.w3c.dom.ls.LSParser#abort()
      */
     public void abort () {
         // If parse operation is in progress then reset it

Modified: xerces/java/trunk/src/org/apache/xerces/util/AttributesProxy.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/util/AttributesProxy.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/util/AttributesProxy.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/util/AttributesProxy.java Sun Sep 24 14:11:28 2006
@@ -24,7 +24,7 @@
 
 /**
  * Wraps {@link XMLAttributes} and makes it look like
- * {@link AttributeList} and {@link Attributes}.
+ * {@link AttributeList} and {@link Attributes2}.
  *
  * @author Arnaud Le Hors, IBM
  * @author Andy Clark, IBM

Modified: xerces/java/trunk/src/org/apache/xerces/xinclude/XIncludeHandler.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/xinclude/XIncludeHandler.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/xinclude/XIncludeHandler.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/xinclude/XIncludeHandler.java Sun Sep 24 14:11:28 2006
@@ -1965,7 +1965,7 @@
      * unparsed entities are processed as described in the spec, sections 4.5.1 and 4.5.2
      * </ul>
      * @param attributes
-     * @return
+     * @return the processed XMLAttributes
      */
     protected XMLAttributes processAttributes(XMLAttributes attributes) {
         if (isTopLevelIncludedItem()) {
@@ -2340,7 +2340,7 @@
      * as an ancestor of the current item.
      *
      * @param depth
-     * @return
+     * @return true if an include was seen at the given depth, false otherwise
      */
     protected boolean getSawInclude(int depth) {
         if (depth >= fSawInclude.length) {
@@ -2782,7 +2782,7 @@
     /**
      * Saves the given language on the top of the stack.
      * 
-     * @param lanaguage the language to push onto the stack.
+     * @param language the language to push onto the stack.
      */
     protected void saveLanguage(String language) {
         fLanguageScope.push(fDepth);

Modified: xerces/java/trunk/src/org/apache/xerces/xpointer/XPointerPart.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/xpointer/XPointerPart.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/xpointer/XPointerPart.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/xpointer/XPointerPart.java Sun Sep 24 14:11:28 2006
@@ -47,7 +47,7 @@
      * Provides scheme specific parsing of a XPointer expression i.e. 
      * the PointerPart or ShortHandPointer.  
      * 
-     * @param  xpointer A String representing the PointerPart or ShortHandPointer.
+     * @param  part A String representing the PointerPart or ShortHandPointer.
      * @throws XNIException Thrown if the PointerPart string does not conform to 
      *         the syntax defined by its scheme.
      *   

Modified: xerces/java/trunk/src/org/apache/xerces/xs/XSLoader.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/xs/XSLoader.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/xs/XSLoader.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/xs/XSLoader.java Sun Sep 24 14:11:28 2006
@@ -55,7 +55,7 @@
      * 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 uri The list of URI locations.
+     * @param uriList The list of URI locations.
      * @return An XSModel representing the schema documents.
      */
     public XSModel loadURIList(StringList uriList);

Modified: xerces/java/trunk/src/org/apache/xml/serialize/BaseMarkupSerializer.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xml/serialize/BaseMarkupSerializer.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xml/serialize/BaseMarkupSerializer.java (original)
+++ xerces/java/trunk/src/org/apache/xml/serialize/BaseMarkupSerializer.java Sun Sep 24 14:11:28 2006
@@ -120,7 +120,7 @@
  * @author <a href="mailto:rahul.srivastava@sun.com">Rahul Srivastava</a>
  * @author Elena Litani, IBM 
  * @see Serializer
- * @see LSSerializer
+ * @see org.w3c.dom.ls.LSSerializer
  */
 public abstract class BaseMarkupSerializer
     implements ContentHandler, DocumentHandler, LexicalHandler,
@@ -414,7 +414,7 @@
      * writer and output format. Throws an exception only if
      * an I/O exception occured while serializing.
      *
-     * @param elem The element to serialize
+     * @param frag The document fragment to serialize
      * @throws IOException An I/O exception occured while
      *   serializing
      */
@@ -1295,7 +1295,6 @@
      * whether the text is printed as CDATA or unescaped.
      *
      * @param text The text to print
-     * @param unescaped True is should print unescaped
      * @throws IOException An I/O exception occured while
      *   serializing
      */
@@ -1513,7 +1512,9 @@
      * Multiple spaces are printed as such, but spaces at beginning
      * of line are removed.
      *
-     * @param text The text to print
+     * @param chars The text to print
+     * @param start The start offset
+     * @param length The number of characters
      * @param preserveSpace Space preserving flag
      * @param unescaped Print unescaped
      */

Modified: xerces/java/trunk/src/org/apache/xml/serialize/XML11Serializer.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xml/serialize/XML11Serializer.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xml/serialize/XML11Serializer.java (original)
+++ xerces/java/trunk/src/org/apache/xml/serialize/XML11Serializer.java Sun Sep 24 14:11:28 2006
@@ -55,9 +55,9 @@
  * The serializer supports both DOM and SAX. SAX serializing is done by firing
  * SAX events and using the serializer as a document handler. DOM serializing is done
  * by calling {@link #serialize(Document)} or by using DOM Level 3  
- * {@link org.w3c.dom.ls.DOMSerializer} and
- * serializing with {@link org.w3c.dom.ls.DOMSerializer#write},
- * {@link org.w3c.dom.ls.DOMSerializer#writeToString}.
+ * {@link org.w3c.dom.ls.LSSerializer} and
+ * serializing with {@link org.w3c.dom.ls.LSSerializer#write},
+ * {@link org.w3c.dom.ls.LSSerializer#writeToString}.
  * <p>
  * If an I/O exception occurs while serializing, the serializer
  * will not throw an exception directly, but only throw it

Modified: xerces/java/trunk/src/org/apache/xml/serialize/XMLSerializer.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xml/serialize/XMLSerializer.java?view=diff&rev=449487&r1=449486&r2=449487
==============================================================================
--- xerces/java/trunk/src/org/apache/xml/serialize/XMLSerializer.java (original)
+++ xerces/java/trunk/src/org/apache/xml/serialize/XMLSerializer.java Sun Sep 24 14:11:28 2006
@@ -64,9 +64,9 @@
  * The serializer supports both DOM and SAX. SAX serializing is done by firing
  * SAX events and using the serializer as a document handler. DOM serializing is done
  * by calling {@link #serialize(Document)} or by using DOM Level 3  
- * {@link org.w3c.dom.ls.DOMSerializer} and
- * serializing with {@link org.w3c.dom.ls.DOMSerializer#write},
- * {@link org.w3c.dom.ls.DOMSerializer#writeToString}.
+ * {@link org.w3c.dom.ls.LSSerializer} and
+ * serializing with {@link org.w3c.dom.ls.LSSerializer#write},
+ * {@link org.w3c.dom.ls.LSSerializer#writeToString}.
  * <p>
  * If an I/O exception occurs while serializing, the serializer
  * will not throw an exception directly, but only throw it
@@ -189,7 +189,7 @@
     /**
      * This methods turns on namespace fixup algorithm during
      * DOM serialization.
-     * @see org.w3c.dom.ls.DOMSerializer
+     * @see org.w3c.dom.ls.LSSerializer
      * 
      * @param namespaces
      */



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xerces.apache.org
For additional commands, e-mail: commits-help@xerces.apache.org