Plugin eadoc v0.1
Overview
EADoc generates xooki
documentation for EasyAnt modules (plugins and buildtypes).
The description for each module is culled from that module's Ivy descriptor.
Information about the module's phases and parameters is taken from the module's
Ant script.
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 |
|---|---|---|---|
| eadoc.module.org | No | org name for easyant modules | * |
| eadoc.documentation.dir | No | target directory for generated documentation | ${target.documentation.dir} |
| eadoc.module.types | No | List of module types to be documented | plugin,buildtype |
| eadoc.repository.name | No | name of the repository to document | local |
| eadoc.module.includes | No | name pattern of modules to document | * |
| target.documentation.dir | No | directory where the documentation will be generated to | ${target}/documentation |
Build Phases
This plugin adds targets to each of the following build phases:
- validate
-
- init: Read and verify property configuration, load required task libraries
- process-documentation-resources
-
- generate: generate documentation for all EasyAnt plugins in the target repository
Extra Targets
This plugin defines some extra Ant targets not attached to any build phase:
- doit