On Fri, 31 Jan 2025 16:19:17 GMT, Hannes Wallnöfer <hann...@openjdk.org> wrote:

> 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.

I went ahead and integtated the PR. We can improve the feature based on how it 
works out in actual use.

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

PR Comment: https://git.openjdk.org/jdk/pull/23395#issuecomment-2796934892

Reply via email to