Code review request for 4891262 "API spec, javax/accessibility: few invalid javadoc tags"
Joe Darcy
Joe.Darcy at Sun.COM
Thu Dec 10 03:08:31 UTC 2009
Hello.
While doing a coredocs build, I noticed once again some javadoc warnings
coming out of the javax.accessibility package and I decided to fix them;
the patch is below and the full webrev is at
http://cr.openjdk.java.net/~darcy/4891262.0/
The changes in AccessibleContext.java were to fix clear typos of the
desired type name. In AccessibleExtendedText, the "chunk" method
doesn't seem to exist so I just deleted the reference. The
AccessibleKeyBinding javadoc makes repeated reference to the
non-existent method AccessibleContext#getAccessibleKeyBinding so I
deleted the references to and discussion of that method.
-Joe
--- old/src/share/classes/javax/accessibility/AccessibleContext.java 2009-12-09 19:00:44.000000000 -0800
+++ new/src/share/classes/javax/accessibility/AccessibleContext.java 2009-12-09 19:00:44.000000000 -0800
@@ -296,7 +296,7 @@
*
* @see #getAccessibleText
* @see #addPropertyChangeListener
- * @see #AccessibleText.AccessibleTextSequence
+ * @see AccessibleTextSequence
*/
public static final String ACCESSIBLE_TEXT_PROPERTY
= "AccessibleText";
@@ -311,7 +311,7 @@
*
* @see #getAccessibleText
* @see #addPropertyChangeListener
- * @see #AccessibleText.AccessibleTextSequence
+ * @see AccessibleTextSequence
*
* @since 1.5
*/
@@ -334,7 +334,7 @@
*
* @see #getAccessibleText
* @see #addPropertyChangeListener
- * @see #AccessibleText.AccessibleAttributeSequence
+ * @see AccessibleAttributeSequence
*
* @since 1.5
*/
--- old/src/share/classes/javax/accessibility/AccessibleExtendedText.java 2009-12-09 19:00:45.000000000 -0800
+++ new/src/share/classes/javax/accessibility/AccessibleExtendedText.java 2009-12-09 19:00:45.000000000 -0800
@@ -45,7 +45,6 @@
* @see Accessible#getAccessibleContext
* @see AccessibleContext
* @see AccessibleContext#getAccessibleText
- * @see AccessibleText.AccessibleTextChunk
*
* @author Peter Korn
* @author Lynn Monsanto
--- old/src/share/classes/javax/accessibility/AccessibleKeyBinding.java 2009-12-09 19:00:46.000000000 -0800
+++ new/src/share/classes/javax/accessibility/AccessibleKeyBinding.java 2009-12-09 19:00:45.000000000 -0800
@@ -32,16 +32,11 @@
* the standard mechanism for an assistive technology to determine the
* key bindings which exist for this object.
* Any object that has such key bindings should support this
- * interface. Applications can determine if an object supports the
- * AccessibleKeyBinding interface by first obtaining its AccessibleContext
- * (see @link Accessible} and then calling the
- * {@link AccessibleContext#getAccessibleKeyBinding} method. If the return
- * value is not null, the object supports this interface.
+ * interface.
*
* @see Accessible
* @see Accessible#getAccessibleContext
* @see AccessibleContext
- * @see AccessibleContext#getAccessibleKeyBinding
*
* @author Lynn Monsanto
* @since 1.4
@@ -58,21 +53,7 @@
/**
* Returns a key binding for this object. The value returned is an
* java.lang.Object which must be cast to appropriate type depending
- * on the underlying implementation of the key. For example, if the
- * Object returned is a javax.swing.KeyStroke, the user of this
- * method should do the following:
- * <nf><code>
- * Component c = <get the component that has the key bindings>
- * AccessibleContext ac = c.getAccessibleContext();
- * AccessibleKeyBinding akb = ac.getAccessibleKeyBinding();
- * for (int i = 0; i < akb.getAccessibleKeyBindingCount(); i++) {
- * Object o = akb.getAccessibleKeyBinding(i);
- * if (o instanceof javax.swing.KeyStroke) {
- * javax.swing.KeyStroke keyStroke = (javax.swing.KeyStroke)o;
- * <do something with the key binding>
- * }
- * }
- * </code></nf>
+ * on the underlying implementation of the key.
*
* @param i zero-based index of the key bindings
* @return a javax.lang.Object which specifies the key binding
More information about the core-libs-dev
mailing list