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

Add metadata to generated API documentation files

    XMLWordPrintable

    Details

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

      Description

      It would be good to add more metadata to the generated API files.

      * "Description" ... a stylized description of the contents of the page, for possible use by tools that might want to filter the set of pages. Of most use would be a description on the pages that contain the specifications for the declaration of an item.

      * "Generator" ... not just "javadoc" but also an indication of the part of javadoc that generated the part, to help identify the different "kinds" of pages in an API bundle.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jjg Jonathan Gibbons
              Reporter:
              jjg Jonathan Gibbons
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: