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

Add javadoc support for restricted methods

    XMLWordPrintable

Details

    Description

      Javadoc should support restricted methods in the Java SE API. The support should be similar to what we do for preview methods that is:

      * In the "method summary" section, restricted methods should be clearly visible.
      * When clicking on a method details, a "bubble" containing more info about what restricted methods are should be shown.
      * Links to restricted methods should be rendered with the classic superscript notation which is used for preview API methods.

      An example of javadoc output can be found here:
      https://cr.openjdk.org/~mcimadamore/jdk/restricted_javadoc/javadoc/java.base/java/lang/foreign/Linker.html#method-summary

      The patch to generate that javadoc is available here:
      https://github.com/openjdk/jdk/compare/master...mcimadamore:jdk:restricted_anno?expand=1

      Attachments

        Issue Links

          Activity

            People

              hannesw Hannes Wallnoefer
              mcimadamore Maurizio Cimadamore
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: