RFR: 8266666: Implementation for snippets

Pavel Rappo prappo at openjdk.java.net
Mon Jul 26 12:59:12 UTC 2021

On Fri, 23 Jul 2021 18:48:27 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> More feedback;
> 1. It seems reasonable to introduce the `...taglets.snippets` package.  It seems excessive to have three sub packages within that, for `actions`, `parser` and `text`, especially when the last contains just a single class.

That package structure was initially there to keep the dependencies clear. That said, I'm okay with squashing it into a single package for practical reasons.

> 2. At some point soonish, we will need API somewhere to get the content of the snippet.  This is necessary to fulfill the goal in the JEP to support validation of snippet content. Without any such API, validation code would have to duplicate at least some of the code to handle snippets. This API should probably not be in `com.sun.source` and should probably be in the `jdk.javadoc` module, perhaps on the existing `StandardDoclet` class.  One way to do that would be to introduce a utility interface to provide access to support for taglets, and then have a method on `StandardDoclet` to access an instance of that utility for a specific snippet, identified by element and/or id.

We can discuss that API either in this PR or in a separate thread on javadoc-dev at openjdk.java.net. (Separately: is this @/at trick still efficient? Modern email-address harvesting is surely smarter than that.)


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

More information about the compiler-dev mailing list