Maven Javafxdoc Plugin

The Javafxdoc Plugin uses the Javafxdoc tool to generate javafxdocs for the specified project.

The Javafxdoc Plugin gets the parameter values that will be used from the plugin configuration specified in the pom. To hold all javafxdoc arguments, packages or files, the Javafxdoc Plugin generates argument files and calls the Javafxdoc tool as follow:

#${project.reporting.outputDirectory}/apidocs/javafxdoc.exe(or .sh) \
    @options @files

When no configuration values are set, the plugin sets default values instead and then executes the Javafxdoc tool.

The JAVAFX_HOME environment variable is used to determine the location of the javafxdoc tool if the location is not specified in the pom. For more information see Setting the JavaFX Home.

Goals Overview

The Javafxdoc Plugin has three goals:

  • javafxdoc:help displays help information for the plugin.
  • javafxdoc:jar generates the Javafxdoc files for the project, then places them into a jar file. It executes the standard Javafxdoc tool and supports the parameters used by the tool.
  • javafxdoc:javafxdoc generates the Javafxdoc files for the project. It executes the standard Javafxdoc tool and supports the parameters used by the tool.

Usage

General instructions on how to use the Javafxdoc Plugin can be found on the usage page. Some more specific use cases are described in the examples given below.

In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably small demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from the source repository and will find supplementary information in the guide to helping with Maven.

Examples

The following examples show how to use the Javafxdoc Plugin in more advanced use cases: