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

Improve javadoc tag specification.

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P3
    • Resolution: Fixed
    • Affects Version/s: 10
    • Fix Version/s: 12
    • Component/s: tools
    • Subcomponent:
    • Resolved In Build:
      b15
    • CPU:
      generic
    • OS:
      generic
    • Verification:
      Not verified

      Description

      The following specification needs some cleanup.
      https://docs.oracle.com/javase/10/docs/specs/doc-comment-spec.html

      1. The table at the end which contains valid locations for javadoc tags, this could be re-written in a nicer way, suggestion is to have a matrix and use a bullet for each application location, the locations are along the X-axis and the tags are on the Y-axis.

      At the very least, duplications can be eliminated using a All declarations with Overview.

      2. The serialField tag erroneously appears in overview, this should not be the case as serialField can only be used fields.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jjg Jonathan Gibbons
              Reporter:
              ksrini Kumar Srinivasan
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: