JEP 413: Code Snippets in Java API Documentation
Gunnar Morling
gunnar at hibernate.org
Fri Apr 30 10:40:50 UTC 2021
Hi all,
It's with great interest that I've learned about JEP 413, I think this will
be a great improvement to the user experience of JavaDoc!
When sharing this online, there was feedback from several folks [1] that
alignment for the region selection syntax with that one of AsciiDoc would
be desirable [2]. That way, one could easily include the same snippet into
JavaDoc and other documentation like a developer guide at the same time. I
believe that'd make lots of sense, so I thought I'd relay this feedback
here.
Best,
--Gunnar
[1] https://twitter.com/maxandersen/status/1388018227868049408
[2]
https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20210430/381e391f/attachment.htm>
More information about the javadoc-dev
mailing list