Frequently Asked Questions

  1. Why is the documentation generated with the plugin empty?
Why is the documentation generated with the plugin empty?

The main reason for empty documentation is the fact that Modules were not detected by Pousse-Café. Without a containing Module, no Aggregate nor service nor process will be shown.

A module is described by an interface extending the Module interface. All components located in the same package as this interface or a sub-package is considered as part of the module.

Another deprecated method is to use a package-info.java in the Module's base package. The package javadoc must contain the @module tag which defines the name of the Module.

All components (including the module's interface or package-info.java file) must be in the base package configured for generate-doc goal.

When your Module is defined in another Maven project, do not forget to put a source dependency on that project as Pousse-Café uses static source code analysis to generate the documentation.

[top]