Goals available for this plugin:
| Goal | Report? | Description |
|---|---|---|
| javafxdoc:help | No | Display help information on maven-javafxdoc-plugin. Call mvn javafxdoc:help -Ddetail=true -Dgoal=<goal-name>to display parameter details. |
| javafxdoc:jar | No | Bundles the Javafxdoc documentation for the JavaFX
code in a NON aggregator project into a jar using the
standard Javafxdoc tool.
Based on the Maven Javadoc Plugin version 2.6. |
| javafxdoc:javafxdoc | Yes | Generates documentation for the JavaFX code in a
NON aggregator project using the standard Javafxdoc Tool.
Based on the Maven Javadoc Plugin version 2.6. |
The following specifies the minimum requirements to run this Maven plugin:
| Maven | 2.0.9 |
| JDK | 1.5 |
| Memory | No minimum requirement. |
| Disk Space | No minimum requirement. |
You should specify the version in your project's plugin configuration:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>net.sf.jfxdplugin</groupId>
<artifactId>maven-javafxdoc-plugin</artifactId>
<version>1.0</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>net.sf.jfxdplugin</groupId>
<artifactId>maven-javafxdoc-plugin</artifactId>
<version>1.0</version>
</plugin>
...
</plugins>
</build>
...
<!-- To use the report goals in your POM or parent POM -->
<reporting>
<plugins>
<plugin>
<groupId>net.sf.jfxdplugin</groupId>
<artifactId>maven-javafxdoc-plugin</artifactId>
<version>1.0</version>
</plugin>
...
</plugins>
</reporting>
...
</project>
For more information, see "Guide to Configuring Plug-ins"