Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more documentation #37

Open
sco0ter opened this issue Apr 3, 2018 · 3 comments
Open

Add more documentation #37

sco0ter opened this issue Apr 3, 2018 · 3 comments

Comments

@sco0ter
Copy link

sco0ter commented Apr 3, 2018

I was reading through https://spotbugs.github.io/spotbugs-maven-plugin/check-mojo.html
and it lacks a lot of documentation.

Most or all properties have (no description).

As a developer I want to know what all these properties do.
E.g. I tried <relaxed>true</relaxed> and noticed that there is more output, i.e. bug analysis is more strict (although it contradicts a relaxed behavior somewhat).

@hazendaz
Copy link
Member

hazendaz commented Feb 3, 2019

@sco0ter We have added groovydocs to the documentation now which does show what the values are. It is unclear to the team right now why running normal build does not pick up those values and in some cases defines items that are not what we have defined. We suspect since the plugin is entirely written in groovy that groovy with maven behaves differently. At the moment no ETA on a better fix.

@hazendaz
Copy link
Member

@hazendaz
Copy link
Member

hazendaz commented Jan 5, 2024

Also see apache/maven-plugin-tools#152

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants