[cp-patches] FYI: API doc fixes in javax.swing.text.html.parser.*

[David Gilbert]

I committed this patch:

2005-07-27  David Gilbert  <address@hidden>

        * javax/swing/text/html/parser/DocumentParser.java: API doc fixes,
        * javax/swing/text/html/parser/DTD.java: likewise,
        * javax/swing/text/html/parser/DTDConstants.java: likewise,
        * javax/swing/text/html/parser/Element.java: likewise,
        * javax/swing/text/html/parser/Parser.java: likewise,
        * javax/swing/text/html/parser/ParserDelegator.java: likewise.

Regards,

Dave Gilbert

Index: javax/swing/text/html/parser/DTD.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/text/html/parser/DTD.java,v
retrieving revision 1.3
diff -u -r1.3 DTD.java
--- javax/swing/text/html/parser/DTD.java       2 Jul 2005 20:32:51 -0000       
1.3
+++ javax/swing/text/html/parser/DTD.java       27 Jul 2005 08:03:46 -0000
@@ -62,7 +62,8 @@
  * <p>
  * If you need more information about SGML DTD documents,
  * the author suggests to read SGML tutorial on
- * address@hidden http://www.w3.org/TR/WD-html40-970708/intro/sgmltut.html}.
+ * <a href="http://www.w3.org/TR/WD-html40-970708/intro/sgmltut.html";
+ * >http://www.w3.org/TR/WD-html40-970708/intro/sgmltut.html</a>.
  * We also recommend Goldfarb C.F (1991) <i>The SGML Handbook</i>,
  * Oxford University Press, 688 p, ISBN: 0198537379.
  * </p>
@@ -402,7 +403,7 @@
    * placed to the field
    * address@hidden javax.swing.text.html.parser.AttributeList#next },
    * creating a linked list.
-   * @return
+   * @return The attributes.
    */
   protected AttributeList defAttributeList(String name, int type, int modifier,
                                            String default_value,
@@ -541,7 +542,7 @@
    * The unknown elements are automatically defined and added
    * to the element table.
    * @param elements
-   * @return
+   * @return The bit set.
    */
   private BitSet bitSet(String[] elements)
   {
Index: javax/swing/text/html/parser/DTDConstants.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/text/html/parser/DTDConstants.java,v
retrieving revision 1.3
diff -u -r1.3 DTDConstants.java
--- javax/swing/text/html/parser/DTDConstants.java      2 Jul 2005 20:32:51 
-0000       1.3
+++ javax/swing/text/html/parser/DTDConstants.java      27 Jul 2005 08:03:47 
-0000
@@ -40,14 +40,16 @@
 
 /**
  * <p>This class defines the SGML basic types, used for describing HTML 4.01
- * at address@hidden http://www.w3.org/TR/html4/types.html }. Not all 
constants,
+ * at <a href="http://www.w3.org/TR/html4/types.html";
+ * >http://www.w3.org/TR/html4/types.html</a>. Not all constants,
  * defined here, are actually used in HTML 4.01 SGML specification. Some others
  * are defined just as part of the required implementation.
  * </p>
  * <p>
  * If you need more information about SGML DTD documents,
  * the author suggests to read SGML tutorial on
- * address@hidden http://www.w3.org/TR/WD-html40-970708/intro/sgmltut.html}.
+ * <a href="http://www.w3.org/TR/WD-html40-970708/intro/sgmltut.html";
+ * >http://www.w3.org/TR/WD-html40-970708/intro/sgmltut.html</a>.
  * We also recommend Goldfarb C.F (1991) <i>The SGML Handbook</i>,
  * Oxford University Press, 688 p, ISBN: 0198537379.
  * </p>
Index: javax/swing/text/html/parser/DocumentParser.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/text/html/parser/DocumentParser.java,v
retrieving revision 1.5
diff -u -r1.5 DocumentParser.java
--- javax/swing/text/html/parser/DocumentParser.java    2 Jul 2005 20:32:51 
-0000       1.5
+++ javax/swing/text/html/parser/DocumentParser.java    27 Jul 2005 08:03:47 
-0000
@@ -167,7 +167,7 @@
    * to get a default DTD; you must either refer to the implementation -
    * specific packages, write your own DTD or obtain the working instance
    * of parser in other way, for example, by calling
-   * address@hidden javax.swing.text.html.HTMLEditorKit#getParser() }.
+   * <code>javax.swing.text.html.HTMLEditorKit.getParser()</code>.
    * @param a_dtd a DTD to use.
    */
   public DocumentParser(DTD a_dtd)
@@ -180,18 +180,18 @@
    * Parses the HTML document, calling methods of the provided
    * callback. This method must be multithread - safe.
    * @param reader The reader to read the HTML document from
-   * @param callback The callback that is notifyed about the presence
+   * @param aCallback The callback that is notifyed about the presence
    * of HTML elements in the document.
    * @param ignoreCharSet If thrue, any charset changes during parsing
    * are ignored.
    * @throws java.io.IOException
    */
-  public void parse(Reader reader, HTMLEditorKit.ParserCallback a_callback,
+  public void parse(Reader reader, HTMLEditorKit.ParserCallback aCallback,
                     boolean ignoreCharSet
                    )
              throws IOException
   {
-    callBack = a_callback;
+    callBack = aCallback;
     gnu.parse(reader);
 
     callBack.handleEndOfLineString(gnu.getEndOfLineSequence());
@@ -230,7 +230,7 @@
    * The method is called when the HTML closing tag ((like &lt;/table&gt;)
    * is found or if the parser concludes that the one should be present
    * in the current position.
-   * @param The tag being handled
+   * @param tag The tag being handled
    */
   protected void handleEndTag(TagElement tag)
   {
@@ -245,7 +245,7 @@
    * The method is called when the HTML opening tag ((like &lt;table&gt;)
    * is found or if the parser concludes that the one should be present
    * in the current position.
-   * @param The tag being handled
+   * @param tag The tag being handled
    */
   protected void handleStartTag(TagElement tag)
   {
Index: javax/swing/text/html/parser/Element.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/text/html/parser/Element.java,v
retrieving revision 1.3
diff -u -r1.3 Element.java
--- javax/swing/text/html/parser/Element.java   2 Jul 2005 20:32:51 -0000       
1.3
+++ javax/swing/text/html/parser/Element.java   27 Jul 2005 08:03:47 -0000
@@ -225,7 +225,7 @@
 
   /**
    * Get all attributes of this document as an attribute list.
-   * @return
+   * @return The attribute list.
    */
   public AttributeList getAttributes()
   {
Index: javax/swing/text/html/parser/Parser.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/text/html/parser/Parser.java,v
retrieving revision 1.4
diff -u -r1.4 Parser.java
--- javax/swing/text/html/parser/Parser.java    2 Jul 2005 20:32:51 -0000       
1.4
+++ javax/swing/text/html/parser/Parser.java    27 Jul 2005 08:03:48 -0000
@@ -327,7 +327,7 @@
    * Handle the tag with no content, like &lt;br&gt;. The method is
    * called for the elements that, in accordance with the current DTD,
    * has an empty content.
-   * @param The tag being handled.
+   * @param tag The tag being handled.
    * @throws javax.swing.text.ChangedCharSetException
    */
   protected void handleEmptyTag(TagElement tag)
@@ -339,7 +339,7 @@
    * The method is called when the HTML closing tag ((like &lt;/table&gt;)
    * is found or if the parser concludes that the one should be present
    * in the current position.
-   * @param The tag being handled
+   * @param tag The tag being handled
    */
   protected void handleEndTag(TagElement tag)
   {
@@ -354,7 +354,7 @@
    * The method is called when the HTML opening tag ((like &lt;table&gt;)
    * is found or if the parser concludes that the one should be present
    * in the current position.
-   * @param The tag being handled
+   * @param tag The tag being handled
    */
   protected void handleStartTag(TagElement tag)
   {
@@ -383,7 +383,7 @@
    * both title starting and closing tags are already behind.
    * The passed argument contains the concatenation of all
    * title text sections.
-   * @param The title text.
+   * @param title The title text.
    */
   protected void handleTitle(char[] title)
   {
@@ -402,7 +402,7 @@
 
   /**
    * Constructs the tag from the given element.
-   * @param the tag base address@hidden javax.swing.text.html.parser.Element}
+   * @param element the tag base address@hidden 
javax.swing.text.html.parser.Element}
    * @param isSupposed true if the tag is not actually present in the
    * html input, but the parser supposes that it should to occur in
    * the current location.
@@ -427,7 +427,7 @@
    * is found or if the parser concludes that the one should be present
    * in the current position. The method is called immediately before
    * calling the handleStartTag.
-   * @param The tag
+   * @param tag The tag
    */
   protected void startTag(TagElement tag)
     throws ChangedCharSetException
Index: javax/swing/text/html/parser/ParserDelegator.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/text/html/parser/ParserDelegator.java,v
retrieving revision 1.7
diff -u -r1.7 ParserDelegator.java
--- javax/swing/text/html/parser/ParserDelegator.java   12 Jul 2005 07:15:41 
-0000      1.7
+++ javax/swing/text/html/parser/ParserDelegator.java   27 Jul 2005 08:03:48 
-0000
@@ -143,7 +143,7 @@
    * Parses the HTML document, calling methods of the provided
    * callback. This method must be multithread - safe.
    * @param reader The reader to read the HTML document from
-   * @param callback The callback that is notifyed about the presence
+   * @param a_callback The callback that is notifyed about the presence
    * of HTML elements in the document.
    * @param ignoreCharSet If thrue, any charset changes during parsing
    * are ignored.
@@ -191,7 +191,7 @@
    * all subsequent calls to the parse(...) . If you need to specify
    * your DTD locally, simply address@hidden 
javax.swing.text.html.parser.Parser}
    * instead.
-   * @param dtd The DTD that will be used to parse documents by this class.
+   * @param a_dtd The DTD that will be used to parse documents by this class.
    * @param name The name of this DTD.
    * @return No standard is specified on which instance of DTD must be
    * returned by this method, and it is recommended to leave the returned