RFR: JDK-8272944: Use snippets in jdk.javadoc documentation

Julia Boes jboes at openjdk.java.net
Fri Dec 3 10:40:18 UTC 2021

On Fri, 3 Dec 2021 00:18:09 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> Please review a patch to convert an example in the `jdk.javadoc` documentation to use snippets instead of raw HTML and/or `{@code }`.  There are some minor tweaks to the text of the example, but no changes to the normative specification of the package.
> Given that the example is in `package-info.java`, a minor change is required in `JavacElements` to ensure that the package symbol is completed (i.e. the `package-info.java` file has been read) when accessing the `PackageElement`.

src/jdk.javadoc/share/classes/jdk/javadoc/doclet/package-info.java line 54:

> 52:  * -- the {@link jdk.javadoc.doclet.Doclet#run(DocletEnvironment) run} interface
> 53:  * method, defines the entry point.
> 54:  * {@snippet id="entry-point" type=java :

What does the `type` attribute do? It's not mentioned in the JEP.


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

More information about the compiler-dev mailing list