README.md: update documentation

This commit is contained in:
Paul Campbell 2017-01-18 12:05:55 +00:00
parent 2516a17851
commit ee2c489ca2

View file

@ -104,7 +104,7 @@ runs the [PMD](http://pmd.sourceforge.net/) code analysis.
Runs its [pmd](https://maven.apache.org/plugins/maven-pmd-plugin/pmd-mojo.html) Runs its [pmd](https://maven.apache.org/plugins/maven-pmd-plugin/pmd-mojo.html)
and [cpd](https://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html) goals and [cpd](https://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html) goals
during the `verify` phase. during the `compile` phase.
### Configuration ### Configuration
@ -138,13 +138,17 @@ For each class not excluded the Instructions Covered Ration must be at least
Excluded from analysis: Excluded from analysis:
* `*Test` - test classes * `*Test` - test classes
* `*IT` - integration test classes
* `*Main` - main classes
* `*Application` - application classes
* `*Configuration` - (Spring) configuration classes
## Maven Source Plugin ## Maven Source Plugin
The [Maven Source Plugin](https://maven.apache.org/plugins/maven-source-plugin/) The [Maven Source Plugin](https://maven.apache.org/plugins/maven-source-plugin/)
bundles your sources into a jar file ready for deployment. bundles your sources into a jar file ready for deployment.
Runs its [jar-no-fork](http://gleclaire.github.io/findbugs-maven-plugin/check-mojo.html) Runs its [jar-no-fork](https://maven.apache.org/plugins/maven-source-plugin/jar-no-fork-mojo.html)
goal during the `verify` phase. goal during the `verify` phase.
### Configuration ### Configuration
@ -157,7 +161,7 @@ The [Maven Javadoc Plugin](https://maven.apache.org/plugins/maven-javadoc-plugin
generates your html javadocs and bundles them into a jar file ready for generates your html javadocs and bundles them into a jar file ready for
deployment. deployment.
Runs its [jar-no-fork](http://gleclaire.github.io/findbugs-maven-plugin/check-mojo.html) Runs its [jar](https://maven.apache.org/plugins/maven-javadoc-plugin/jar-mojo.html)
goal during the `verify` phase. goal during the `verify` phase.
### Configuration ### Configuration
@ -191,7 +195,7 @@ classes.
### Configuration ### Configuration
The plugin will `analyse` the project during the `verify` phase. The plugin will `analyse` the project during the `compile` phase.
## Digraph Dependency Plugin ## Digraph Dependency Plugin