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

Review the presentation of annotations on modules

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Duplicate
    • Icon: P3 P3
    • None
    • None
    • tools
    • None

      From Magnus:



      On 2017-04-07 17:49, Jonathan Gibbons wrote:
      > That's because the module is probably deprecated for removal. Check the module-info.java.
      >
      > The ugly looking "@Deprecated(since="9", forRemoval=true)" is just the standard listing of any annotations on the module declaration.

      I realized this was due to the tag in module-info.java. My reaction was on how this was rendered in the Javadoc. It just looks horrible!

      If you compare with other elements (methods, packages, classes) that include the @Deprecated tag, it is listed in a code-formatted ("pre") section, so it looks like part of the source code declaration.

      Here it is listed atop the "Module java.xml.ws.annotation" title, with a non-code-formatted font and a huge gap between the @Deprecation text and the title.

      If anything, the text after the "Module java.xml.ws.annotation" title should include something like:

      <pre>
      @Deprecated(since="9", forRemoval=true)
      module java.xml.ws.annotation
      </pre>

      Or, just the text "Deprecated, for removal: This API element is subject to removal in a future version." itself should be enough, if no "code snippet" is outputted in the module javadoc pages.

      /Magnus

            hannesw Hannes Wallnoefer
            jjg Jonathan Gibbons
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: