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

improve presentation of annotations for modules and packages

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P3
    • Resolution: Fixed
    • Affects Version/s: 15
    • Fix Version/s: 16
    • Component/s: tools

      Description

      (See attached screenshots for images of the following text fragments.)

      For a type element, annotations are displayed as part of the "signature" block, in text like this:

      type-description.png
      --------------------
      Module m
      Package p
      Class C

      java.lang.Object
      p.C
      @Anno
      public class C
      extends java.lang.Object
      This is a class.
      --------------------

      However, for a module or package, there is currently no equivalent "signature block", and so the annotations get pushed up into the header (i.e. the <div> immediately below the top navbar, like this:

      module-description.png
      --------------------
      @Anno

      Module m

      This is a module.
      --------------------

      package-description.png
      --------------------
      Module m
      @Anno

      Package p

      This is a package.
      --------------------

      This definitely looks "weird" and the annotation looks out of place.

      A better solution would be to introduce an analogous signature block, similar to that provided on type declaration pages.

      This would also help regularize the structure between the pages for module/package/type declaration pages.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                hannesw Hannes Wallnoefer
                Reporter:
                jjg Jonathan Gibbons
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: