RFR: 8346109: Create JDK taglet for additional preview notes
Hannes Wallnöfer
hannesw at openjdk.org
Mon Apr 7 18:08:02 UTC 2025
Please review a patch to add a JavaDoc Taglet to the JDK build system that allows to add preview-related notes to non-preview API elements, as well as a hidden javadoc option to add elements with preview notes to the preview summary page.
The {@previewNote} tag uses the following syntax:
{@previewNote <jep-number> [preview note title]}
preview note text
{@previewNote}
```
Elements with preview notes are listed in a separate table titled "Elements containing Preview Notes" in the preview summary page.
To support the feature, the algorithm in `PreviewAPIListBuilder.java` was changed to retrieve the preview JEP info in advance before looping through API elements. While this is not strictly necessary, it makes the code a bit nicer, and it also allows us to avoid checking for preview API elements when processing non-JDK code.
-------------
Commit messages:
- Add test for hidden --preview-note-tag option
- Avoid NPE and unnecessary work
- Merge branch 'master' into JDK-8346109
- Minor Cleanup
- Add PreviewNote taglet and hidden --preview-note-tag option
Changes: https://git.openjdk.org/jdk/pull/23395/files
Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=23395&range=00
Issue: https://bugs.openjdk.org/browse/JDK-8346109
Stats: 357 lines in 8 files changed: 297 ins; 39 del; 21 mod
Patch: https://git.openjdk.org/jdk/pull/23395.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/23395/head:pull/23395
PR: https://git.openjdk.org/jdk/pull/23395
More information about the build-dev
mailing list