[cp-patches] FYI: API doc fixes in javax.accessibility.* package

[David Gilbert]

I committed this patch to fix some minor API doc issues:

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

        * javax/accessibility/AccessibleComponent.java: minor API doc fixes,
        * javax/accessibility/AccessibleRelation.java: likewise,
        * javax/accessibility/AccessibleRelationSet.java: likewise,
        * javax/accessibility/AccessibleResourceBundle.java: likewise,
        * javax/accessibility/AccessibleRole.java: likewise,
        * javax/accessibility/AccessibleState.java: likewise,
        * javax/accessibility/AccessibleStateSet.java: likewise,
        * javax/accessibility/AccessibleText.java: likewise.

I'll hold any further patches until Mark releases 0.17.

Regards,

Dave Gilbert

Index: javax/accessibility/AccessibleComponent.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/accessibility/AccessibleComponent.java,v
retrieving revision 1.8
diff -u -r1.8 AccessibleComponent.java
--- javax/accessibility/AccessibleComponent.java        2 Jul 2005 20:32:45 
-0000       1.8
+++ javax/accessibility/AccessibleComponent.java        13 Jul 2005 13:40:04 
-0000
@@ -117,7 +117,7 @@
    * Get the font of this component
    *
    * @return the font of the component, or null if not supported
-   * @see setFont(Font)
+   * @see #setFont(Font)
    */
   Font getFont();
 
Index: javax/accessibility/AccessibleRelation.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/accessibility/AccessibleRelation.java,v
retrieving revision 1.3
diff -u -r1.3 AccessibleRelation.java
--- javax/accessibility/AccessibleRelation.java 2 Jul 2005 20:32:45 -0000       
1.3
+++ javax/accessibility/AccessibleRelation.java 13 Jul 2005 13:40:04 -0000
@@ -1,5 +1,5 @@
 /* AccessibleRelation.java -- the relation between accessible objects
-   Copyright (C) 2002 Free Software Foundation
+   Copyright (C) 2002, 2005 Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -36,6 +36,8 @@
 exception statement from your version. */
 
 package javax.accessibility;
+
+import java.util.Locale;
 
 /**
  * The relation between one accessible object and one or more other objects.
Index: javax/accessibility/AccessibleRelationSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/accessibility/AccessibleRelationSet.java,v
retrieving revision 1.3
diff -u -r1.3 AccessibleRelationSet.java
--- javax/accessibility/AccessibleRelationSet.java      2 Jul 2005 20:32:45 
-0000       1.3
+++ javax/accessibility/AccessibleRelationSet.java      13 Jul 2005 13:40:04 
-0000
@@ -1,5 +1,5 @@
 /* AccessibleRelationSet.java -- the combined relations of an accessible object
-   Copyright (C) 2002 Free Software Foundation
+   Copyright (C) 2002, 2005 Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -37,6 +37,7 @@
 
 package javax.accessibility;
 
+import java.util.Locale;
 import java.util.Vector;
 
 /**
@@ -159,7 +160,7 @@
   /**
    * Check if the relation key is in the set.
    *
-   * @param relation the relation to locate
+   * @param key the relation to locate
    * @return true if it is in the set
    */
   public boolean contains(String key)
@@ -174,7 +175,7 @@
   /**
    * Get the relation that matches the key.
    *
-   * @param relation the relation to locate
+   * @param key the relation to locate
    * @return the relation in the set, or null
    */
   public AccessibleRelation get(String key)
Index: javax/accessibility/AccessibleResourceBundle.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/accessibility/AccessibleResourceBundle.java,v
retrieving revision 1.4
diff -u -r1.4 AccessibleResourceBundle.java
--- javax/accessibility/AccessibleResourceBundle.java   2 Jul 2005 20:32:45 
-0000       1.4
+++ javax/accessibility/AccessibleResourceBundle.java   13 Jul 2005 13:40:04 
-0000
@@ -39,13 +39,14 @@
 package javax.accessibility;
 
 import java.util.ListResourceBundle;
+import java.util.Locale;
 
 /**
  * This class is deprecated. It once was used for localizing accessibility
  * strings, and was never meant for external use anyway.
  *
  * @author Eric Blake (address@hidden)
- * @see AccessibleBundle.toDisplayString(String, Locale)
+ * @see AccessibleBundle#toDisplayString(String, Locale)
  * @since 1.2
  * @deprecated this class is no longer used
  * @status updated to 1.4
Index: javax/accessibility/AccessibleRole.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/accessibility/AccessibleRole.java,v
retrieving revision 1.4
diff -u -r1.4 AccessibleRole.java
--- javax/accessibility/AccessibleRole.java     2 Jul 2005 20:32:45 -0000       
1.4
+++ javax/accessibility/AccessibleRole.java     13 Jul 2005 13:40:05 -0000
@@ -1,5 +1,5 @@
 /* AccessibleRole.java -- the primary role of an accessible object
-   Copyright (C) 2002 Free Software Foundation
+   Copyright (C) 2002, 2005 Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -36,6 +36,8 @@
 exception statement from your version. */
 
 package javax.accessibility;
+
+import java.util.Locale;
 
 /**
  * The role of an accessible object. For example, this could be "button" or
Index: javax/accessibility/AccessibleState.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/accessibility/AccessibleState.java,v
retrieving revision 1.4
diff -u -r1.4 AccessibleState.java
--- javax/accessibility/AccessibleState.java    2 Jul 2005 20:32:45 -0000       
1.4
+++ javax/accessibility/AccessibleState.java    13 Jul 2005 13:40:05 -0000
@@ -1,5 +1,5 @@
 /* AccessibleState.java -- a state of an accessible object
-   Copyright (C) 2002 Free Software Foundation
+   Copyright (C) 2002, 2005 Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -36,6 +36,9 @@
 exception statement from your version. */
 
 package javax.accessibility;
+
+import java.awt.Dimension;
+import java.util.Locale;
 
 /**
  * A state portion of an accessible object. A combination of states represent
Index: javax/accessibility/AccessibleStateSet.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/accessibility/AccessibleStateSet.java,v
retrieving revision 1.4
diff -u -r1.4 AccessibleStateSet.java
--- javax/accessibility/AccessibleStateSet.java 2 Jul 2005 20:32:45 -0000       
1.4
+++ javax/accessibility/AccessibleStateSet.java 13 Jul 2005 13:40:05 -0000
@@ -1,5 +1,5 @@
 /* AccessibleStateSet.java -- the combined state of an accessible object
-   Copyright (C) 2002 Free Software Foundation
+   Copyright (C) 2002, 2005 Free Software Foundation
 
 This file is part of GNU Classpath.
 
@@ -37,6 +37,7 @@
 
 package javax.accessibility;
 
+import java.util.Locale;
 import java.util.Vector;
 
 /**
Index: javax/accessibility/AccessibleText.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/accessibility/AccessibleText.java,v
retrieving revision 1.9
diff -u -r1.9 AccessibleText.java
--- javax/accessibility/AccessibleText.java     2 Jul 2005 20:32:45 -0000       
1.9
+++ javax/accessibility/AccessibleText.java     13 Jul 2005 13:40:06 -0000
@@ -125,7 +125,7 @@
    * Returns the section of text at the index, or null if the index or part
    * is invalid.
    *
-   * @param part address@hidden CHARACTER}, address@hidden WORD}, or 
address@hidden SENTENCE}
+   * @param part address@hidden #CHARACTER}, address@hidden #WORD}, or 
address@hidden #SENTENCE}
    * @param index the 0-based character index
    * @return the selection of text at that index, or null
    */
@@ -135,7 +135,7 @@
    * Returns the section of text after the index, or null if the index or part
    * is invalid.
    *
-   * @param part address@hidden CHARACTER}, address@hidden WORD}, or 
address@hidden SENTENCE}
+   * @param part address@hidden #CHARACTER}, address@hidden #WORD}, or 
address@hidden #SENTENCE}
    * @param index the 0-based character index
    * @return the selection of text after that index, or null
    */
@@ -145,7 +145,7 @@
    * Returns the section of text before the index, or null if the index or part
    * is invalid.
    *
-   * @param part address@hidden CHARACTER}, address@hidden WORD}, or 
address@hidden SENTENCE}
+   * @param part address@hidden #CHARACTER}, address@hidden #WORD}, or 
address@hidden #SENTENCE}
    * @param index the 0-based character index
    * @return the selection of text before that index, or null
    */