United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4891262 API spec, javax/accessibility: few invalid javadoc tags
JDK-4891262 : API spec, javax/accessibility: few invalid javadoc tags

Details
Type:
Bug
Submit Date:
2003-07-16
Status:
Resolved
Updated Date:
2010-01-08
Project Name:
JDK
Resolved Date:
2010-01-08
Component:
client-libs
OS:
generic
Sub-Component:
javax.accessibility
CPU:
generic
Priority:
P5
Resolution:
Fixed
Affected Versions:
1.3.1,1.4.0,1.4.1,5.0
Fixed Versions:

Related Reports
Backport:
Duplicate:
Duplicate:

Sub Tasks

Description
Name: aaR10208			Date: 07/16/2003



Filed By       : J2SE-SQA [###@###.###
JDK            : JDK1.5.0-b10
Platform[s]    : generic

There are few invalid javadoc tags in the javax/accessibility classes:
===
javax/accessibility/AccessibleHypertext.java:37: warning - @version tag has no arguments.
javax/accessibility/AccessibleKeyBinding.java:31: warning - Tag @link: can't find getAccessibleKeyBinding in javax.accessibility.AccessibleContext
javax/accessibility/AccessibleKeyBinding.java:31: warning - Tag @link: can't find getAccessibleKeyBinding in javax.accessibility.AccessibleContext
javax/accessibility/AccessibleKeyBinding.java:31: warning - Tag @link: can't find getAccessibleKeyBinding in javax.accessibility.AccessibleContext
javax/accessibility/AccessibleKeyBinding.java:31: warning - Tag @see: can't find getAccessibleKeyBinding in javax.accessibility.AccessibleContext
===


======================================================================

                                    

Comments
EVALUATION



Name: dk30142			Date: 07/19/2003

Accepted

======================================================================
                                     
2004-06-11
SUGGESTED FIX

# HG changeset patch
# User darcy
# Date 1260480487 28800
# Node ID aa0d374b40a5f9a41177d7900326e3647976ad95
# Parent f9c9c2b726a02ba4bd193db8c5def382b4cd5f5e
4891262: API spec, javax/accessibility: few invalid javadoc tags
Reviewed-by: jjg

--- a/src/share/classes/javax/accessibility/AccessibleContext.java	Thu Dec 10 13:04:13 2009 -0800
+++ b/src/share/classes/javax/accessibility/AccessibleContext.java	Thu Dec 10 13:28:07 2009 -0800
@@ -296,7 +296,7 @@ public abstract class AccessibleContext 
      *
      * @see #getAccessibleText
      * @see #addPropertyChangeListener
-     * @see #AccessibleText.AccessibleTextSequence
+     * @see AccessibleTextSequence
      */
     public static final String ACCESSIBLE_TEXT_PROPERTY
         = "AccessibleText";
@@ -311,7 +311,7 @@ public abstract class AccessibleContext 
      *
      * @see #getAccessibleText
      * @see #addPropertyChangeListener
-     * @see #AccessibleText.AccessibleTextSequence
+     * @see AccessibleTextSequence
      *
      * @since 1.5
      */
@@ -334,7 +334,7 @@ public abstract class AccessibleContext 
      *
      * @see #getAccessibleText
      * @see #addPropertyChangeListener
-     * @see #AccessibleText.AccessibleAttributeSequence
+     * @see AccessibleAttributeSequence
      *
      * @since 1.5
      */
--- a/src/share/classes/javax/accessibility/AccessibleExtendedText.java	Thu Dec 10 13:04:13 2009 -0800
+++ b/src/share/classes/javax/accessibility/AccessibleExtendedText.java	Thu Dec 10 13:28:07 2009 -0800
@@ -45,7 +45,6 @@ import javax.swing.text.*;
  * @see Accessible#getAccessibleContext
  * @see AccessibleContext
  * @see AccessibleContext#getAccessibleText
- * @see AccessibleText.AccessibleTextChunk
  *
  * @author       Peter Korn
  * @author       Lynn Monsanto
--- a/src/share/classes/javax/accessibility/AccessibleKeyBinding.java	Thu Dec 10 13:04:13 2009 -0800
+++ b/src/share/classes/javax/accessibility/AccessibleKeyBinding.java	Thu Dec 10 13:28:07 2009 -0800
@@ -32,16 +32,11 @@ package javax.accessibility;
  * 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 @@ public interface AccessibleKeyBinding {
     /**
      * 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
                                     
2009-12-10
PUBLIC COMMENTS

See
http://hg.openjdk.java.net/jdk7/tl/jdk/rev/aa0d374b40a5
                                     
2009-12-10



Hardware and Software, Engineered to Work Together