Editing
ANT doclet
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Features == === Basics === The doclet parses the "[https://github.com/aunkrig/antology/blob/master/antology/src/main/resources/de/unkrig/antology/ant.xml 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 "<Code>setFoo(String)</code>" and "<code>addPerson(Person)</code>", but like "<code>foo=...</code>" and "<code><person></code>". 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 [http://antology.unkrig.de/antdoc/tasks/swingLookAndFeel.html#attributes_summary example]. === Grouping of attributes and subelements === Attribute setter methods ("<code>set*()</code>") and subelement adder methods ("<code>add*()</code>", "<code>addConfigured*()</code>" and "<code>create*()</code>") can have a "<code>@ant.group</code> ''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 <code>@ant.group</code> 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 <code>@ant.valueExplanation</code> block tag); the possible values (for enums) from the enum constants, and the (optional) default value from the method parameter type and the <code>@ant.defaultValue</code> block tag. The <code>@ant.mandatory</code> 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.
Summary:
Please note that all contributions to unkrig.de may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Unkrig.de:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
View history
More
Search
Navigation
Main page
Recent changes
Random page
Help
Tools
What links here
Related changes
Special pages
Page information