Param tags in javadoc

Elliotte Harold <[email protected]> Sun, 25 Apr 2004 08:50:54 -0400
Newsgroups gmane.text.xml.sax.devel
Message-ID <[email protected]>
I've attached a patch for the current CVS that fixes a number of 
mismatched @param tags in the JavaDoc. Yell if you have any troubles 
with this.

--
Elliotte Rusty Harold
param.patch (text/plain, 8.9 KB)
? docs
Index: src/org/xml/sax/AttributeList.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/AttributeList.java,v
retrieving revision 1.6
diff -u -r1.6 AttributeList.java
--- src/org/xml/sax/AttributeList.java	30 Jan 2002 21:13:42 -0000	1.6
+++ src/org/xml/sax/AttributeList.java	25 Apr 2004 12:36:43 -0000
@@ -181,7 +181,7 @@
      * <p>If the attribute name has a namespace prefix in the document,
      * the application must include the prefix here.</p>
      *
-     * @param i The index of the attribute in the list.
+     * @param name the name of the attribute to return
      * @return The attribute value as a string, or null if
      *         no such attribute exists.
      * @see #getValue(int)
Index: src/org/xml/sax/HandlerBase.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/HandlerBase.java,v
retrieving revision 1.6
diff -u -r1.6 HandlerBase.java
--- src/org/xml/sax/HandlerBase.java	30 Jan 2002 21:13:44 -0000	1.6
+++ src/org/xml/sax/HandlerBase.java	25 Apr 2004 12:36:43 -0000
@@ -213,8 +213,7 @@
      * each element (such as finalising a tree node or writing
      * output to a file).</p>
      *
-     * @param name The element type name.
-     * @param attributes The specified or defaulted attributes.
+     * @param name the element name
      * @exception org.xml.sax.SAXException Any SAX exception, possibly
      *            wrapping another exception.
      * @see org.xml.sax.DocumentHandler#endElement
Index: src/org/xml/sax/XMLReader.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/XMLReader.java,v
retrieving revision 1.8
diff -u -r1.8 XMLReader.java
--- src/org/xml/sax/XMLReader.java	21 Apr 2002 23:50:34 -0000	1.8
+++ src/org/xml/sax/XMLReader.java	25 Apr 2004 12:36:43 -0000
@@ -358,7 +358,7 @@
      * has ended.  If a client application wants to terminate 
      * parsing early, it should throw an exception.</p>
      *
-     * @param source The input source for the top-level of the
+     * @param input The input source for the top-level of the
      *        XML document.
      * @exception org.xml.sax.SAXException Any SAX exception, possibly
      *            wrapping another exception.
Index: src/org/xml/sax/ext/Locator2Impl.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/ext/Locator2Impl.java,v
retrieving revision 1.2
diff -u -r1.2 Locator2Impl.java
--- src/org/xml/sax/ext/Locator2Impl.java	12 Jan 2002 19:06:15 -0000	1.2
+++ src/org/xml/sax/ext/Locator2Impl.java	25 Apr 2004 12:36:43 -0000
@@ -20,7 +20,7 @@
  *
  * <p> This is not part of core-only SAX2 distributions.</p>
  *
- * @since SAX 2.0 (extensions 1.1 alpha)
+ * @since SAX 2.0.2
  * @author David Brownell
  * @version TBS
  */
@@ -93,7 +93,7 @@
     /**
      * Assigns the current value of the encoding property.
      *
-     * @param version the new "encoding" value
+     * @param encoding the new "encoding" value
      * @see #getEncoding
      */
     public void setEncoding (String encoding)
Index: src/org/xml/sax/helpers/DefaultHandler.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/helpers/DefaultHandler.java,v
retrieving revision 1.8
diff -u -r1.8 DefaultHandler.java
--- src/org/xml/sax/helpers/DefaultHandler.java	30 Jan 2002 20:52:25 -0000	1.8
+++ src/org/xml/sax/helpers/DefaultHandler.java	25 Apr 2004 12:36:44 -0000
@@ -261,7 +261,7 @@
      *        performed.
      * @param qName The qualified name (with prefix), or the
      *        empty string if qualified names are not available.
-     * @param atts The attributes attached to the element.  If
+     * @param attributes The attributes attached to the element.  If
      *        there are no attributes, it shall be an empty
      *        Attributes object.
      * @exception org.xml.sax.SAXException Any SAX exception, possibly
Index: src/org/xml/sax/helpers/NamespaceSupport.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/helpers/NamespaceSupport.java,v
retrieving revision 1.14
diff -u -r1.14 NamespaceSupport.java
--- src/org/xml/sax/helpers/NamespaceSupport.java	23 Apr 2004 01:34:30 -0000	1.14
+++ src/org/xml/sax/helpers/NamespaceSupport.java	25 Apr 2004 12:36:44 -0000
@@ -406,12 +406,10 @@
      * to check for a default prefix, use the {@link #getURI getURI}
      * method with an argument of "".</p>
      *
-     * @param uri The Namespace URI.
-     * @param isAttribute true if this prefix is for an attribute
-     *        (and the default Namespace is not allowed).
-     * @return One of the prefixes currently mapped to the URI supplied,
+     * @param uri the namespace URI
+     * @return one of the prefixes currently mapped to the URI supplied,
      *         or null if none is mapped or if the URI is assigned to
-     *         the default Namespace.
+     *         the default namespace
      * @see #getPrefixes(java.lang.String)
      * @see #getURI
      */
Index: src/org/xml/sax/helpers/ParserAdapter.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/helpers/ParserAdapter.java,v
retrieving revision 1.15
diff -u -r1.15 ParserAdapter.java
--- src/org/xml/sax/helpers/ParserAdapter.java	8 Mar 2004 13:01:01 -0000	1.15
+++ src/org/xml/sax/helpers/ParserAdapter.java	25 Apr 2004 12:36:44 -0000
@@ -295,7 +295,7 @@
     /**
      * Set the DTD handler.
      *
-     * @param resolver The new DTD handler.
+     * @param handler the new DTD handler
      * @see org.xml.sax.XMLReader#setEntityResolver
      */
     public void setDTDHandler (DTDHandler handler)
@@ -307,7 +307,7 @@
     /**
      * Return the current DTD handler.
      *
-     * @return The current DTD handler, or null if none was supplied.
+     * @return the current DTD handler, or null if none was supplied
      * @see org.xml.sax.XMLReader#getEntityResolver
      */
     public DTDHandler getDTDHandler ()
@@ -319,7 +319,7 @@
     /**
      * Set the content handler.
      *
-     * @param resolver The new content handler.
+     * @param handler the new content handler
      * @see org.xml.sax.XMLReader#setEntityResolver
      */
     public void setContentHandler (ContentHandler handler)
@@ -343,7 +343,7 @@
     /**
      * Set the error handler.
      *
-     * @param resolver The new error handler.
+     * @param handler The new error handler.
      * @see org.xml.sax.XMLReader#setEntityResolver
      */
     public void setErrorHandler (ErrorHandler handler)
@@ -410,7 +410,7 @@
     }
 
 
-
+
     ////////////////////////////////////////////////////////////////////
     // Implementation of org.xml.sax.DocumentHandler.
     ////////////////////////////////////////////////////////////////////
Index: src/org/xml/sax/helpers/XMLFilterImpl.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/helpers/XMLFilterImpl.java,v
retrieving revision 1.8
diff -u -r1.8 XMLFilterImpl.java
--- src/org/xml/sax/helpers/XMLFilterImpl.java	30 Jan 2002 20:52:37 -0000	1.8
+++ src/org/xml/sax/helpers/XMLFilterImpl.java	25 Apr 2004 12:36:44 -0000
@@ -253,7 +253,7 @@
     /**
      * Set the DTD event handler.
      *
-     * @param resolver The new DTD handler.
+     * @param handler the new DTD handler
      */
     public void setDTDHandler (DTDHandler handler)
     {
@@ -275,7 +275,7 @@
     /**
      * Set the content event handler.
      *
-     * @param resolver The new content handler.
+     * @param handler the new content handler
      */
     public void setContentHandler (ContentHandler handler)
     {
@@ -297,7 +297,7 @@
     /**
      * Set the error event handler.
      *
-     * @param handle The new error handler.
+     * @param handler the new error handler
      */
     public void setErrorHandler (ErrorHandler handler)
     {
Index: src/org/xml/sax/helpers/XMLReaderAdapter.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/helpers/XMLReaderAdapter.java,v
retrieving revision 1.8
diff -u -r1.8 XMLReaderAdapter.java
--- src/org/xml/sax/helpers/XMLReaderAdapter.java	30 Jan 2002 20:52:39 -0000	1.8
+++ src/org/xml/sax/helpers/XMLReaderAdapter.java	25 Apr 2004 12:36:45 -0000
@@ -107,7 +107,7 @@
     }
 
 
-
+
     ////////////////////////////////////////////////////////////////////
     // Implementation of org.xml.sax.Parser.
     ////////////////////////////////////////////////////////////////////
@@ -119,7 +119,7 @@
      * <p>This is not supported in SAX2, and will always throw
      * an exception.</p>
      *
-     * @param The locale for error reporting.
+     * @param locale the locale for error reporting.
      * @see org.xml.sax.Parser#setLocale
      * @exception org.xml.sax.SAXException Thrown unless overridden.
      */