ANT doclet

Generates (JAVADOC-like) HTML documentation for APACHE ANT antlibs.

The motivation for writing this doclet is to ease the maintenance of the documentation for the Ant-contrib.unkrig.de antlib:

Usage

The doclet implements the following command line options:

-d directory

The directory where the output files are created; defaults to ".".

-windowtitle window-title

-doctitle document-title

-header header

-footer footer

-top top

-bottom bottom

-notimestamp true|false

-link url-or-file

-linkoffline url-or-file package-list-irk-or-file

Same as for the standard JAVADOC doclet

-antlib-file file

The antlib file of the antlib to document; defaults to "antlib.xml".

-theme JAVA7|JAVA8

The style of the generated pages.

Features

Grouping of subelements

Subelement adder methods ("add*()", "addConfigured*()" and "create*()") can have a "@ant.group group-name" block tag in their DOC comment. If at least one subelement adder method has such a block tag, then the subelements are grouped by group-name, and each group gets a respective heading, and the subelements without a @ant.group go into a group "Other".

For an example, see the documentation of the <zzfind> ANT task, and the source code.

Resources

The doclet JAR file is here.

The change log is here.

Find the source code for the doclet here.