RFR: 8266666: Implementation for snippets [v13]

Jonathan Gibbons jjg at openjdk.java.net
Tue Aug 24 17:25:30 UTC 2021


On Tue, 24 Aug 2021 13:14:57 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> This PR implements JEP 413 "Code Snippets in Java API Documentation", which hasn't been yet proposed to target JDK 18. The PR starts as a squashed merge of the https://github.com/openjdk/jdk-sandbox/tree/jdk.javadoc/snippets branch.
>
> Pavel Rappo has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Clarify the attributes order comment

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java line 82:

> 80:      */
> 81:     snippet,
> 82: 

This is OK for now, given that we do not have a "public" way to process these comments at this time. However, we should probably do a cleanup later on (soon), and maybe create a new section in `HtmlStyle` for all snippet related styles ... i.e. including `bold`, `italic` etc, so that all styles end up in the upcoming documentation.

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

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


More information about the compiler-dev mailing list