Opens, reads and parses ANTLIB files and resources, and generates one document per type, task, macro, preset and script defined therein.

Doclet command line options:

-d directory

Where to create documentation in HTML format (optional).

The effective file name is:

<dest-dir>/<ant-type-group>/<ant-type>.html

The default destination directory is ".".

-splitindex

Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.

-docencoding charset

The charset to use when writing the HTML files. The default is the JVM default charset, "${file.encoding}".

-charset name

The HTML character set for this document.

-doctitle html-text

The title to place near the top of the overview summary file. The text specified in the title tag is placed as a centered, level-one heading directly beneath the top navigation bar. The title tag can contain HTML tags and white space.

-header text

The header text to be placed at the top of each output file. The header is placed to the right of the upper navigation bar. The header can contain HTML tags and white space.

-footer text

The footer text to be placed at the bottom of each output file. The footer value is placed to the right of the lower navigation bar. The footer value can contain HTML tags and white space.

-top text

The text to be placed at the top of each output file.

-bottom text

The text to be placed at the bottom of each output file. The text is placed at the bottom of the page, underneath the lower navigation bar. The text can contain HTML tags and white space.

-quiet

Suppress normal output.

-notimestamp

Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page. This is useful when you want to run the javadoc command on two source bases and get the differences between diff them, because it prevents time stamps from causing a diff (which would otherwise be a diff on every page). The time stamp includes the javadoc command release number.

-antlib-file file

The ANTLIB file to parse, see the documentation of the ANTLIB concept.

-antlib-resource name

The name of an ANTLIB resource to parse, see the documentation of the ANTLIB concept.

-link external-documentation-url

See the JAVADOC tool documentation for the "-link" command line option.

-linkoffline external-documentation-url package-list-location

See the JAVADOC tool documentation for the "-linkofflin" command line option.

-tag spec

For compatibility with the standard JAVADOC doclet; ignored.

-theme JAVA7|JAVA8

Which style sheets and resources to use.

-sourcepath source-path

Takes also effect for loading ANTLIB resources.

-classpath class-path

Takes also effect for loading ANTLIB resources.

-windowtitle text

See the JAVADOC tool documentation for the "-windowtitle" command line option.

Supported tags:

The following block tags may appear in the DOC comment of a class declaration that maps to an ANT type:

{@ant.typeGroupName type-group-name}

The name of the "type group" that the type belongs to, e.g. "Task".

{@ant.typeGroupSubdir dir-name}

The name of the subdirectory that contains the documentation of all ANT types of the type group; e.g. "tasks".

{@ant.typeGroupHeading text}

The heading to display above the list of types; e.g. "Tasks".

{@ant.typeTitleMf message-format}

The message format to use to render the heading on each type details page; e.g. "Task "<{0}>""

{@ant.typeHeadingMf message-format}

The message format to use to render the title (i.e. the tooltip) of the heading on each type details page; e.g. "Task "<code><{0}></code>""

{@ant.group group-name}

Attribute and subelement descriptions are grouped by group name

{@ant.subelementOrder inheritedFirst}

Enforces that the subelements inherited from superclasses appear before the non-inherited. The default is that the subelements in their "natural" order.