Plugin javadoc v0.1
Overview
This module provides javadoc feature.
Parameters
The following property values can be changed to tune the behavior of this plugin.
Required parameters must be defined upon import, or the build will fail.
| Parameter | Required? | Description | Default |
|---|---|---|---|
| target.javadoc | No | base directory where javadoc will be generated | ${target.report}/javadoc |
| target.javadoc.main | No | directory where javadoc will be generated | ${target.javadoc}/main |
| target.report | No | base directory for reports | ${target}/report |
| src.test.java | Yes | directory where test sources to be compiled are | |
| target.javadoc.test | No | directory where javadoc for tests will be generated | ${target.javadoc}/test |
| src.main.java | Yes | directory where sources to be compiled are | |
| javadoc.file.encoding | No | encoding used for generated javadoc | UTF-8 |
Build Phases
This plugin adds targets to each of the following build phases:
- validate
-
- init
- package
-
- package: generate a package containing javadoc
- report
-
- javadoc: generate javadoc report for main classes and test classes
Extra Targets
This plugin defines some extra Ant targets not attached to any build phase:
- doit