Goals Overview

The Plugin Report Plugin has two goals:

• plugin-report:report which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo).
• plugin-report:report-no-fork which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo) without forking the process-classes phase again. Note that this goal does require generation of classes before site generation, e.g. by invoking mvn clean verify site.

Usage

General instructions on how to use the Plugin Report Plugin can be found on the usage page.

In case you still have questions regarding the plugin's usage 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 little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.

Examples

The following examples shows how to use the Plugin Report Plugin in more advanced usecases:

• Configuring Generation of Documentation Reports