aboutsummaryrefslogtreecommitdiff
path: root/jacoco-maven-plugin
diff options
context:
space:
mode:
authorMirko Friedenhagen <mfriedenhagen@gmail.com>2013-11-29 23:20:41 +0100
committerMirko Friedenhagen <mfriedenhagen@gmail.com>2013-11-29 23:20:41 +0100
commitc566346dc2320dd8ccb0dab725e4180639de9cb5 (patch)
tree5200962131039c6e766628c9d1190ba724309f1b /jacoco-maven-plugin
parent0dbd9687afce808c115bd843ae596d3c10db9ac5 (diff)
downloadjacoco-c566346dc2320dd8ccb0dab725e4180639de9cb5.tar.gz
Update documentation of CheckMojo and explain the need for an implmentation hint with Maven-2
Diffstat (limited to 'jacoco-maven-plugin')
-rw-r--r--jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java10
1 files changed, 7 insertions, 3 deletions
diff --git a/jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java b/jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java
index 5202e926..9036872b 100644
--- a/jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java
+++ b/jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java
@@ -54,6 +54,10 @@ public class CheckMojo extends AbstractJacocoMojo implements IViolationsOutput {
* If a limit refers to a ratio the range is from 0.0 to 1.0 where the
* number of decimal places will also determine the precision in error
* messages.
+ *
+ * Note that you <b>must</b> use <tt>implmentation</tt> hints for
+ * <tt>rule</tt> and <tt>limit</tt> when using Maven 2, with Maven 3 you
+ * do not need to specify the attributes.
* </p>
*
* <p>
@@ -64,15 +68,15 @@ public class CheckMojo extends AbstractJacocoMojo implements IViolationsOutput {
* <pre>
* {@code
* <rules>
- * <rule>
+ * <rule implementation="org.jacoco.maven.RuleConfiguration">
* <element>BUNDLE</element>
* <limits>
- * <limit>
+ * <limit implementation="org.jacoco.report.check.Limit">
* <counter>INSTRUCTION</counter>
* <value>COVEREDRATIO</value>
* <minimum>0.80</minimum>
* </limit>
- * <limit>
+ * <limit implementation="org.jacoco.report.check.Limit">
* <counter>CLASS</counter>
* <value>MISSEDCOUNT</value>
* <maximum>0</maximum>