commit cc0755617bba4de74a122dfc30ad25039cfde265
author Marc R. Hoffmann <hoffmann@mountainminds.com> Sat May 25 15:39:12 2013 +0200
committer Marc R. Hoffmann <hoffmann@mountainminds.com> Sat May 25 15:39:12 2013 +0200
tree 108d6cddd6fdbbff1e097eebc555805f8fe83463
parent 7d588f9eab46c11e7f8b01c8b268dd21320a3708

Improve documentation on how to specify coverage ratios.

jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java

diff --git a/jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java b/jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java
index d964734..b438658 100644
--- a/jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java
+++ b/jacoco-maven-plugin/src/org/jacoco/maven/CheckMojo.java
@@ -50,6 +50,9 @@
 	 * applies to a certain counter (INSTRUCTION, LINE, BRANCH, COMPLEXITY,
 	 * METHOD, CLASS) and defines a minimum or maximum for the corresponding
 	 * value (TOTALCOUNT, COVEREDCOUNT, MISSEDCOUNT, COVEREDRATIO, MISSEDRATIO).
+	 * 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.
 	 * </p>
 	 * 
 	 * <p>
@@ -93,7 +96,7 @@
 	 *     </excludes>
 	 *     <limits>
 	 *       <limit>
-	 *         <entity>LINE</entity>
+	 *         <counter>LINE</counter>
 	 *         <value>COVEREDRATIO</value>
 	 *         <minimum>0.50</minimum>
 	 *       </limit>

org.jacoco.doc/docroot/doc/ant.html

diff --git a/org.jacoco.doc/docroot/doc/ant.html b/org.jacoco.doc/docroot/doc/ant.html
index 09f013d..224ca13 100644
--- a/org.jacoco.doc/docroot/doc/ant.html
+++ b/org.jacoco.doc/docroot/doc/ant.html
@@ -716,9 +716,9 @@
 
 <pre class="source lang-xml linenums">
 &lt;check&gt;
-    &lt;rule elementtype="PACKAGE"&gt;
-        &lt;limit entity="LINE" value="COVEREDRATIO" minimum="0.80"/&gt;
-        &lt;limit entity="CLASS" value="MISSEDCOUNT" maximum="0"/&gt;
+    &lt;rule element="PACKAGE"&gt;
+        &lt;limit counter="LINE" value="COVEREDRATIO" minimum="0.80"/&gt;
+        &lt;limit counter="CLASS" value="MISSEDCOUNT" maximum="0"/&gt;
     &lt;/rule&gt;
 &lt;/check&gt;
 </pre>
@@ -749,7 +749,7 @@
     <tr>
       <td><code>violationsproperty</code></td>
       <td>The name of an Ant property which is filled with the violation
-          messages.</code></td>
+          messages.</td>
       <td><i>none</i></td>
     </tr>
   </tbody>
@@ -790,7 +790,7 @@
     </tr>
     <tr>
       <td><code>limits</code></td>
-      <td>List of limits to check.</code></td>
+      <td>List of limits to check.</td>
       <td><i>none</i></td>
     </tr>
   </tbody>
@@ -823,17 +823,19 @@
       <td>The counter value that should be checked. Possible options are
       <code>TOTALCOUNT</code>, <code>MISSEDCOUNT</code>,
       <code>COVEREDCOUNT</code>, <code>MISSEDRATIO</code> and
-      <code>COVEREDRATIO</code>.
+      <code>COVEREDRATIO</code>.</td>
       <td><code>COVEREDRATIO</code></td>
     </tr>
     <tr>
       <td><code>minimum</code></td>
-      <td>Expected minmimum value.</code></td>
+      <td>Expected minmimum value. If the minimum 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.</td>
       <td><i>none</i></td>
     </tr>
     <tr>
       <td><code>maximum</code></td>
-      <td>Expected maximum value.</code></td>
+      <td>Expected maximum value.</td>
       <td><i>none</i></td>
     </tr>
   </tbody>