RFR: 8277300: Issues with javadoc support for preview features [v2]

Jan Lahoda jlahoda at openjdk.java.net
Fri Dec 17 13:03:57 UTC 2021


> This is a patch that tweaks a bit the PREVIEW superscript which is marking preview APIs in javadoc. This is based on the experience with the Loom's fibers javadoc.
> 
> Namely, the changes are:
> 
>  * for methods inside a preview class:
>    * show the PREVIEW superscript, unless:
>    * the reference is inside the enclosing (preview) class, in which case skip the PREVIEW superscript
>    * ensure the PREVIEW superscript refers to the class' Preview note, not to the non-existing method's Preview note
> * for preview classes nested inside preview classes, ensure these are considered preview by themselves, not only as referring to a preview class
> * avoid the PREVIEW superscript inside code snippets.
> 
> A sample javadoc with these changes is here:
> http://cr.openjdk.java.net/~jlahoda/8277300/fibers-docs.00/api/java.base/java/util/concurrent/StructuredExecutor.html
> http://cr.openjdk.java.net/~jlahoda/8277300/fibers-docs.00/api/java.base/java/util/concurrent/StructuredExecutor.CompletionHandler.html

Jan Lahoda has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains four additional commits since the last revision:

 - Merge branch 'master' into JDK-8277300
 - Cleanup
 - Cleanup
 - 8277300: Issues with javadoc support for preview features

-------------

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/6848/files
  - new: https://git.openjdk.java.net/jdk/pull/6848/files/b12b5027..5ed89c02

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=6848&range=01
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=6848&range=00-01

  Stats: 5277 lines in 184 files changed: 2443 ins; 2171 del; 663 mod
  Patch: https://git.openjdk.java.net/jdk/pull/6848.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/6848/head:pull/6848

PR: https://git.openjdk.java.net/jdk/pull/6848


More information about the javadoc-dev mailing list