| Release-level Ant targets: |
| javadoc |
Creates one javadoc report for the whole release
in the ${antmod.javadoc.release.dest} directory.
Events fired: javadoc-pre, javadoc-post.
|
| javadoc-modules |
Generate Java API documentation per module.
It does this by iterating across all modules in the release
and runs the "javadoc" target of each module.
Events fired: javadoc-modules-pre, javadoc-modules-post.
|
| Module-level Ant targets: |
| javadoc |
Generate Java API documentation for this module
in the ${antmod.javadoc.module.dest} directory.
Events fired: javadoc-pre, javadoc-post.
|
| Configurable properties: [...] |
| antmod.javadoc.release.destdir |
Target directory for generated release-level javadoc output. Defaults to ${antmod.release.dirs.build}/javadoc. |
| antmod.javadoc.module.destdir |
Target directory for generated module-level javadoc output. Defaults to ${antmod.module.dirs.build}/javadoc. |
| antmod.javadoc.access |
The scope of classes and members to include in the javadoc:
one of public, protected,
package, or private.
Defaults to protected. |
| antmod.javadoc.additionalparam |
Lets you add additional parameters to the javadoc command line. Useful for doclets. Parameters containing spaces need to be quoted using ".
Example (to print what version of javadoc you are using):
antmod.javadoc.additionalparam=-J-showversion
Defaults to empty. |
| antmod.javadoc.author |
Include @author paragraphs. Defaults to true. |
| antmod.javadoc.breakiterator |
Use the new breakiterator algorithm for computing the 1st sentence (yes | no).
You are advised to always use this.
Defaults to yes. |
| antmod.javadoc.defaultexcludes |
Indicates whether Ant's default excludes should be used (yes | no). Defaults to yes. |
| antmod.javadoc.doclet |
Specifies the class file that starts the doclet used in generating the documentation. Defaults to com.sun.tools.doclets.standard.Standard. |
| antmod.javadoc.docletpath |
Specifies the path to the doclet class when calling javadoc with a custom doclet. Defaults to empty. |
| antmod.javadoc.excludepackagenames |
Comma separated list of packages to exclude from the javadoc. Defaults to empty. |
| antmod.javadoc.locale |
Locale to be used, e.g. en_US or en_US_WIN. Works like the "-locale" option of the javadoc command. Defaults to ${user.language}_${user.country}. |
| antmod.javadoc.maxmemory |
Max amount of memory to allocate to the javadoc VM. Defaults to 128m. |
| antmod.javadoc.overview |
Filename. Add additional overview documentation to the overview page of the javadoc.
The documentation must be an HTML file, specified relative to the release directory.
Example: "util/doc/api-overview.html".
Make sure that the file starts and ends with a "<body>" html tag.
Defaults to empty. |
| antmod.javadoc.packagenames |
Comma separated list of package files (with terminating wildcard) included in the javadoc generation. Defaults to "org.*, net.*, com.*, nl.*". |
| antmod.javadoc.source.default |
Is only used by this plugin if ${antmod.javac.source}
is not set (but ${antmod.javac.source}
is always set in the default Antmod distributions).
Represents the Java version the sources should be compatible with.
Defaults to 1.5. |
| antmod.javadoc.use |
Create class and package usage pages. Defaults to true. |
| antmod.javadoc.useexternalfile |
Indicates whether the sourcefile name specified in srcfiles or as nested
source elements should be written to a temporary file to make the command line
shorter (yes | no). Defaults to no. |
| antmod.javadoc.version |
Include @version paragraphs. Defaults to true. |
