Plugin xooki v0.1
Overview
This module provides functionalities for setting up a xooki-based documentation structure in your project.
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 |
|---|---|---|---|
| documentation.css.dir | No | path where the css are stored, used for nice looking HTML | ${src.documentation.dir}/style |
| xooki.temp.dir | No | Temporary directory for xooki use. | ${target}/temp-doc |
| src.documentation.dir | No | Xooki source documentation. | ${basedir}/src/documentation |
| xooki.resources.exclude.pattern | No | Pattern describing files excluded in xooki documentation generation | |
| xooki.resources.include.pattern | No | Pattern describing files included in xooki documentation generation | style/**,images/** |
| xooki.history.dir | No | directory where documentation history version are stored (used to update config.extra.js) | ${src.documentation.dir}/history |
| xooki.checkUpToDate | No | Proxies for the checkUpToDate xooki:generate task. Defaults to true. | true |
| target.artifacts | No | destination directory for target artifacts | ${target}/artifacts |
| 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
- process-documentation-resources
-
- -copy-resources
- -configure-history
- documentation
-
- generate
- package
-
- package
Extra Targets
This plugin defines some extra Ant targets not attached to any build phase:
- create-skeleton
- doit