ANT doclet

From unkrig.de
Jump to: navigation, search

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 Antology antlib:

Antdoc-ant-contrib.png

Contents

Usage

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 &quot;&lt;{0}&gt;&quot;"
{@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 &amp;quot;&lt;code>&lt;{0}&gt;&lt;/code>&amp;quot;"
{@ant.group group-name}
Attributes (or subelements) with equal group-name are grouped, and the group-name is rendered as a heading above the group.
{@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.

Features

Basics

The doclet parses the "ANTLIB file" of your ANTLIB to identify all the tasks, types, chainable readers etc. that the ANTLIB implements. Then it finds the attribut setter and subelement adder methods, just like ANT would do. Eventually it generates one HTML page for each task, type, chainable reader etc., plus various overview, summary, index and frameset pages; very similar to what the standard JAVADOC servlet does for a set of Java classes.

References to attribute setter and subelement adder methods are not rendered as "setFoo(String)" and "addPerson(Person)", but like "foo=..." and "<person>".

Links to the various standard ANT types are recognized and rendered appropriately.

Related attributes

Sometimes you want to document multiple attributes together, i.e. have only one description. To get that, write a doc comment with a description for the first setter, and for the other setters a doc comment with a sole @see tag that refers to the first setter. Here is an example.

Grouping of attributes and subelements

Attribute setter methods ("set*()") and subelement adder methods ("add*()", "addConfigured*()" and "create*()") can have a "@ant.group group-name" block tag in their DOC comment. If at least one attribute setter method (resp. subelement adder method) has such a block tag, then the attributes (resp. 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".

Attribute value documentation

The ANT doclet visualizes the meaning, the possible values and the default values for each attribute. The meaning is derived from the method parameter type and name (or the @ant.valueExplanation block tag); the possible values (for enums) from the enum constants, and the (optional) default value from the method parameter type and the @ant.defaultValue block tag.

The @ant.mandatory block tag appends " (mandatory)" to the attribute description title.

Custom type groups

The ANT doclet analyzes the types and, based on the interfaces they implement, assigns them to "type groups", which will later appear in the left-hand-side frame. The well-known type groups are: "Tasks", "Resource collections", "Chainable readers", "Conditions and "Other types". It is also possible to assign types to your own custom type groups, by adding the following block tags to the type:

/**
 * This type lives in a custom "type group". For this example, we re-use the values for the "Tasks" type group -- please use your own instead.
 *
 * @ant.typeGroupSubdir  tasks
 * @ant.typeGroupName    Task
 * @ant.typeGroupHeading Tasks
 * @ant.typeTitleMf      Task "&lt;{0}&gt;"
 * @ant.typeHeadingMf    <code>&lt;{0}&gt;</code>
 */

Ordering of subelements

If an ANT type (e.g. a task) or a subelement has this block tag

/**
 * @ant.subelementOrder inheritedFirst
 */

, then the subelements inherited from superclasses and interfaces are rendered before the subelements of the actual class. The default behavior is the other way round.

Resources

The doclet JAR file is here.

Find the source code for the doclet here.

Change Log

Version 1.0.5, 2016-11-25
  • ANTLIB includes are now looked up through the javadoc sourcepath AND the javadoc classpath.
  • Modified the text of the copyright notice slightly: Replaced "author" with "copyright holders and contributors".
Version 1.0.4, 2016-11-15
  • The "-doctitle" command line option had no effect.
Version 1.0.3, 2016-11-07
  • Allow for multiple "-antlib-file" options.
  • Also process NESTED antlib files.

License

The ANT doclet is available under the terms of the "new BSD license":

Copyright (c) 2015, Arno Unkrig All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of no-template nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox