Permalink
Browse files

Add documentation for choosing report format (#19)

Closes #15
  • Loading branch information...
ChaitanyaPramod committed Sep 10, 2018
1 parent 51b6b0a commit 3c060a2a967d1b052b1db06d46ff6ab6196a62ae
Showing with 24 additions and 0 deletions.
  1. +12 −0 README.md
  2. +12 −0 docs/index.md
View
@@ -75,6 +75,18 @@ android {
}
```
### Report Format
By default, XML reports are generated. You can add the following snippet to get HTML reports
```groovy
tasks.withType(FindBugs) {
reports {
xml.enabled = false
html.enabled = true
}
}
```
## Contributing
Contributers will find looking through [sources](https://github.com/gradle/gradle/tree/master/subprojects/code-quality/src/main/groovy/org/gradle/api/plugins/quality) of `FindBugs`, `FindBugsExtension` and `FindBugsPlugin` useful.
View
@@ -80,5 +80,17 @@ android {
}
{% endhighlight %}
### Report Format
By default, XML reports are generated. You can add the following snippet to get HTML reports
{% highlight groovy %}
tasks.withType(FindBugs) {
reports {
xml.enabled = false
html.enabled = true
}
}
{% endhighlight %}
## Contributing
Contributions are welcome. Contributers will find looking through [Gradle sources](https://github.com/gradle/gradle/tree/master/subprojects/code-quality/src/main/groovy/org/gradle/api/plugins/quality) of the classes [`FindBugs`](https://github.com/gradle/gradle/blob/master/subprojects/code-quality/src/main/groovy/org/gradle/api/plugins/quality/FindBugs.java), [`FindBugsExtension`](https://github.com/gradle/gradle/blob/master/subprojects/code-quality/src/main/groovy/org/gradle/api/plugins/quality/FindBugsExtension.java) and [`FindBugsPlugin`](https://github.com/gradle/gradle/blob/master/subprojects/code-quality/src/main/groovy/org/gradle/api/plugins/quality/FindBugsPlugin.java) useful.

0 comments on commit 3c060a2

Please sign in to comment.