search

siom79 / japicmp

Comparison of two versions of a jar archive
https://siom79.github.io/japicmp
Apache License 2.0
694 stars 107 forks source link

Use maven-plugin-plugin to auto-generate goal doc #243

Open kingle opened 5 years ago

kingle commented 5 years ago

For the maven plugin, could we add to the <reporting> section:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-plugin-plugin</artifactId>
    <version>3.0</version>
</plugin>

and have it automatically generate the plugin-info.html and cmp-report-mojo.html and other <goal>-report-mojo.html that are more consistent with how other maven plugins are documented? We'd need to move the documentation into javadoc in the Mojo itself so it can generate the appropriate descriptions.

Also, would it be possible to consider putting at least some (or all) of the fields currently in the parameter object higher up as first class configuration options?

siom79 commented 5 years ago

You can try to add the additional reports, if you like.

Changing the interface is not an option as all users would have to change their configuration.