JEP 413 Questions
Gunnar Morling
gunnar at hibernate.org
Mon Oct 18 15:32:10 UTC 2021
Hi all,
Over the weekend, I've been playing a bit with JEP 413, and the first
impression is really great! Thanks a lot for improving the tooling here.
I've written a quick blog post about this, which you can find at [1]. Based
on that, I've had a few questions about things which were not quite clear
to me from the JEP:
* 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
* (How) can I have end-of-line comments which should be propagated to
rendered docs (e.g. explaining the code on that line) but also contain some
tag?
* When including an external snippet, I got a superfluous empty line at the
beginning of the snippet (see last example in the blog post); is there any
way to avoid that?
Thanks again,
--Gunnar
[1] https://www.morling.dev/blog/executable-javadoc-code-snippets/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20211018/cf839e82/attachment.htm>
More information about the javadoc-dev
mailing list