JEP 413 Questions

[Jonathan Gibbons]

On 10/26/21 5:46 AM, Pavel Rappo wrote:
>> * When not explicitly specifying the snippet path, where will JavaDoc look for the default exactly? Say I'm following the standard Maven project structure with a source dir under src/main/java, where would the snippet directory be expected by default? I've tried different places, but always ran into "snippet-files" being treated as a (non-valid) package name
> The "snippet-files" directory is expected to be rooted at the package that refers to an external snippet. If a build tool or an IDE considers "snippet-files" as a package itself, then it might be problematic.
>

Yes, `snippet-files` is deliberately not a valid Java identifier, and so 
cannot be part of a package name and should not be treated as such by 
build tools. The name was chosen to be similar to `doc-files` although 
it was uncommon for `doc-files` to contain source code.

-- Jon
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20211026/e0617c1f/attachment.htm>