Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8050912

javadoc for com.sun.java.accessibility.util is missing from Java Accessibility documentation

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: 7u6, 8, 9
    • Fix Version/s: 9
    • Component/s: docs
    • Subcomponent:
    • Introduced In Version:
      7u6

      Description

      Back at 7u6 the Java Access Bridge was integrated into the JDK/JRE. An oversight of that effort was to not include the javadoc for the com.sun.java.accessibility.util package.

      A new link and related sub-pages could be added to
      http://download.java.net/jdk9/docs/technotes/guides/access/index.html

      Is the fact that the package starts with com.sun going to be a problem?
      If so, is there precedent as to how to manage a package name change from
      com.sun.*?

      Although this package name is prefixed with com.sun the earlier version of the documentation is available as follows:
      - Go to Java Accessibility Utilities
          http://docs.oracle.com/cd/E17802_01/j2se/javase/technologies/accessibility/docs/jaccess-1.3/doc/
      - Follow Java Accessibility Utilities Examples
          http://docs.oracle.com/cd/E17802_01/j2se/javase/technologies/accessibility/docs/jaccess-1.3/doc/examples.html
      - Follow API Reference (top of page)
          http://docs.oracle.com/cd/E17802_01/j2se/javase/technologies/accessibility/docs/jaccess-1.3/doc/api/com/sun/java/accessibility/util/package-summary.html

      Note that if we want the 9 pages to look like those first two 1.3 pages I'll need to spend some time to determine what is technically correct at this point in time. I also have a work item (JDK-8056925) to add at least Ferret and Monkey to 9 and the Examples page indicates other utilities, though Ferret and Monkey are the ones that are in common use.

      I noticed this issue when working on
      https://bugs.openjdk.java.net/browse/JDK-8044820
      Consider removing externalization of GUIInitializedMulticaster and
      TopLevelWindowMulticaster

      I've changed those two methods from public to package-private. It looks
      like just that change will ensure that javadoc doesn't get generated for
      those two classes.

      The source is located in the repos at
      jdk/src/closed/windows/classes/com/sun/java/accessibility/util.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                rgallard Raymond Gallardo
                Reporter:
                ptbrunet Pete Brunet (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: