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

Poor doc for accessibility inner classes in awt and swing packages.

XMLWordPrintable

    • rc2
    • sparc
    • solaris_2.6



      Name: aaC67449 Date: 03/09/2000


      The javadoc for accessibility inner classes are very poor. It looks like, It was
      simply copied from interface descriptions, and says nothing about inner class
       specific behavior.

      In general, the javadoc should say, that the corresponding inner class
      ( AccessibleAWTList for example) takes care of all accessibility support of the
      outer class (java.awt.List).
      But it says only: "
      The class used to obtain the accessible role for this object.
      "
      The List.AccessibleAWTList.AccessibleAWTListChild class has no docs at all.

      All of inner class methods should be correctly documented too.
      The java doc should not say something like this:
      "
      public int getAccessibleActionCount()

             Return the number of Actions available in this object. If there is more
      than one, the first one is the "default" action.
             Specified by:
                    getAccessibleActionCount in interface AccessibleAction
             Returns:
                    the number of Actions in this object


      "
      but should specify determinate value (for example "Returns: 1").

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

            asommere Alan Sommerer (Inactive)
            alisunw Ali Ali (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: