Code snippets in Javadoc

Jaroslav Tulach jaroslav.tulach at gmail.com
Fri Jan 8 07:35:58 UTC 2016


Hi.
I am NetBeans founder responsible for NetBeans Platform APIs, author of the
first book about API design[1], inventor of various Javadoc related tools
used by NetBeans as well as other projects. Currently I am responsible for
API of Truffle[2] and infrastructure used to generate it.

To make sure code samples in the Javadoc are always up to date I've created
codesnippet4javadoc doclet:
https://github.com/jtulach/codesnippet4javadoc

it adds new {@codesnippet} tag and an option -snippetpath to standard
doclet. Get more details at the project page. I believe such functionality
would be welcomed by any Java project. Should you be willing to include it
in standard doclet, I am ready to prepare patch for Open JDK.

Let me know if you are interested. If so, what is the deadline to have the
patch ready?
Thanks.

Jaroslav Tulach
NetBeans Platform Architect

[1] http://practical.apidesign.org
[2] https://github.com/graalvm/truffle


More information about the javadoc-next-dev mailing list