Frequently Asked Questions
General
- What is this project all about?
- The configuration is very limited. Are there plans to add configuration properties as in the maven-javadoc-plugin?
Usage
General
- What is this project all about?
-
This Maven plugin aims to show the output of the Javadoc tool in form of a report. It is very simple and tailored to our specific needs. We wanted to have the output shown in a report instead of searching the warnings from the console output. A second concern was to make visible that the comments of our sources are free of errors and warnings (and if not, these deficiencies are visible to clients of our software).
- The configuration is very limited. Are there plans to add configuration properties as in the maven-javadoc-plugin?
- We do not plan to extend this plugin in near future. If you have feature requests or want to provide a patch, please do not hesitate to contact us.
Usage
- How can I run the report standalone?
-
Simply type
on the command line.
mvn de.smartics.maven.plugin:apidoc-maven-plugin:apidoc-report
- Is there help how to configure the plugin?
- Please refer to Usage.