Groovy 2 Cookbook

Generating documentation for Groovy code

All Java developers are familiar with Javadoc comment style and the javadoc command-line tool, which is well integrated into all major IDEs and build tools.

Unfortunately, you will not be able to run the javadoc tool against Groovy source code, just because javadoc does not recognize the Groovy language syntax - unless your Groovy classes or scripts are written in Java. This is why Groovy has a tool, which for obvious reasons is called Groovydoc. It shares a lot of features with its predecessor but also has some significant differences. For example, groovydoc does not implement the Doclet extension feature, which was used mainly for code generation but since the introduction of annotations in Java 5, its ...