Re: JEP 413: Code Snippets in Java API Documentation

2021-05-04 Thread Pavel Rappo
Thanks for relaying that Twitter discussion. Although we've surveyed multiple systems before agreeing on the snippet markup syntax that satisfies the needs of our initial use case, OpenJDK, it is possible that we've missed some important features. What are the important features of AsciiDoc's T

JEP 413: Code Snippets in Java API Documentation

2021-05-03 Thread Gunnar Morling
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 desi

New candidate JEP: 413: Code Snippets in Java API Documentation

2021-04-28 Thread mark . reinhold
https://openjdk.java.net/jeps/413 Summary: Introduce an @snippet tag for JavaDoc's Standard Doclet, to simplify the inclusion of example source code in API documentation. - Mark