Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / jacoco / b623ffb71ba97fb1ceee4efb4ae0976c1849e955 / . / org.jacoco.doc / docroot / doc / ant.html
blob: b0e5c58bb49e8db848cbd16c24db5228719e9ea0 [file] [log] [blame]
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]1<?xml version="1.0" encoding="ISO-8859-1" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
4<head>
5 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
6 <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
Marc R. Hoffmanna760f322010-03-10 22:23:52 +0000[diff] [blame]7 <link rel="stylesheet" href="../coverage/.resources/prettify.css" charset="ISO-8859-1" type="text/css" />
8 <script type="text/javascript" src="../coverage/.resources/prettify.js"></script>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]9 <title>JaCoCo - Ant Tasks</title>
10</head>
Marc R. Hoffmanna760f322010-03-10 22:23:52 +0000[diff] [blame]11<body onload="prettyPrint()">
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]12
13<div class="breadcrumb">
14 <a href="../index.html" class="el_session">JaCoCo</a> &gt;
15 <a href="index.html" class="el_group">Documentation</a> &gt;
16 <span class="el_source">Ant Tasks</span>
17</div>
Marc R. Hoffmann17be2692010-02-02 05:44:47 +0000[diff] [blame]18<div id="content">
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]19
20<h1>Ant Tasks</h1>
21
22<p>
23 JaCoCo comes with Ant tasks to launch Java programs with execution recording
Marc R. Hoffmannb8a77462009-08-21 14:53:50 +0000[diff] [blame]24 and for creating coverage reports from the recorded data. The JaCoCo Ant tasks
25 require
26</p>
27
28<ul>
29 <li>Ant 1.7.0 or higher and</li>
30 <li>Java 1.5 or higher (for both, the Ant runner and the test executor).</li>
31</ul>
32
33
Marc R. Hoffmann57f9ab42009-08-24 10:52:42 +0000[diff] [blame]34<p>All tasks are defined in <code>jacocoant.jar</code> (which is part of the
35 distribution) and can be included in your Ant scripts with the usual
36 <code>taskdef</code> declaration:
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]37</p>
38
Marc R. Hoffmanna760f322010-03-10 22:23:52 +0000[diff] [blame]39<pre class="source lang-xml">
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]40<span class="nr"> 1</span>&lt;project name="Example" xmlns:jacoco="antlib:org.jacoco.ant"&gt;
41<span class="nr"> 2</span>
42<span class="nr"> 3</span> &lt;taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml"&gt;
43<span class="nr"> 4</span> &lt;classpath&gt;
Marc R. Hoffmanndb930772009-08-20 17:17:37 +0000[diff] [blame]44<span class="nr"> 5</span> &lt;pathelement location="<i>path_to_jacoco</i>/lib/jacocoant.jar"/&gt;
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]45<span class="nr"> 6</span> &lt;/classpath&gt;
46<span class="nr"> 7</span> &lt;/taskdef&gt;
47<span class="nr"> 8</span>
48<span class="nr"> 9</span> ...
49<span class="nr"> 10</span>
50<span class="nr"> 11</span>&lt;/project&gt;
51</pre>
52
53<p>
Marc R. Hoffmanndb3e7d02009-08-12 10:57:39 +0000[diff] [blame]54 Alternatively you might also place the <code>jacocoant.jar</code> in your
55 Ant <code><i>ANT_HOME</i>/lib</code> folder. If you use the name space URI
56 <code>antlib:org.jacoco.ant</code> for JaCoCo tasks Ant will find them
57 automatically without the <code>taskdef</code> declaration above.
58</p>
59
60<p>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]61 Declaring a XML namespace for JaCoCo tasks is optional but always recommended
62 if you mix tasks from different libraries. All subsequent examples use the
63 <code>jacoco</code> prefix declared above.
64</p>
65
66
Brock Janiczakd267c572010-01-28 09:53:54 +0000[diff] [blame]67<h2><a name="coverage">Task <code>coverage</code></a></h2>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]68
69<p>
70 The standard Ant tasks to launch Java programs are <code>java</code> and
71 <code>junit</code>. To add code coverage recording to these tasks they can
72 simply be wrapped with the <code>coverage</code> task as shown in the
73 following examples:
74</p>
75
Marc R. Hoffmanna760f322010-03-10 22:23:52 +0000[diff] [blame]76<pre class="source lang-xml">
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]77<span class="nr"> 1</span>&lt;jacoco:coverage>
78<span class="nr"> 2</span> &lt;java classname="org.jacoco.examples.HelloJaCoCo" fork="true"&gt;
79<span class="nr"> 3</span> &lt;classpath&gt;
80<span class="nr"> 4</span> &lt;pathelement location="./bin"/&gt;
81<span class="nr"> 5</span> &lt;/classpath&gt;
82<span class="nr"> 6</span> &lt;/java&gt;
83<span class="nr"> 7</span>&lt;/jacoco:coverage&gt;
84<span class="nr"> 8</span>
85<span class="nr"> 9</span>
86<span class="nr"> 10</span>&lt;jacoco:coverage>
87<span class="nr"> 11</span> &lt;junit fork="true" forkmode="once"&gt;
88<span class="nr"> 12</span> &lt;test name="org.jacoco.examples.HelloJaCoCoTest"/&gt;
89<span class="nr"> 13</span> &lt;classpath&gt;
90<span class="nr"> 14</span> &lt;pathelement location="./bin"/&gt;
91<span class="nr"> 15</span> &lt;/classpath&gt;
92<span class="nr"> 16</span> &lt;/junit&gt;
93<span class="nr"> 17</span>&lt;/jacoco:coverage>
94</pre>
95
96<p>
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]97 Resulting coverage information is collected during execution and written
98 to a file when the process terminates. Note the <code>fork</code> attribute
99 above in the wrapped <code>java</code> task.
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]100</p>
101
102<p class="hint">
103 The nested task always has to declare <code>fork="true"</code>, otherwise the
104 <code>coverage</code> task can't record coverage information and will fail.
105 In addition the <code>junit</code> task should declare
106 <code>forkmode="once"</code> to avoid starting a new JVM for every single test
107 case and decreasing execution performance dramatically (unless this is
108 required by the nature of the test cases).
109</p>
110
111<p>
112 The coverage task must wrap exactly one task. While it typically works without
113 any configuration, the behavior can be adjusted with some optional attributes:
114</p>
115
116<table class="coverage">
117 <thead>
118 <tr>
119 <td>Attribute</td>
120 <td>Description</td>
121 <td>Default</td>
122 </tr>
123 </thead>
124 <tbody>
125 <tr>
Brock Janiczakd267c572010-01-28 09:53:54 +0000[diff] [blame]126 <td><code>enabled</code></td>
127 <td>If set to <code>true</code> coverage data will be collected for the contained task.</td>
128 <td><code>true</code></td>
129 </tr>
Marc R. Hoffmanne3ef2f32010-01-28 18:17:46 +0000[diff] [blame]130 <tr>
Brock Janiczak003d47c2010-01-15 00:45:17 +0000[diff] [blame]131 <td><code>destfile</code></td>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]132 <td>Path to the output file for execution data.</td>
133 <td><code>jacoco.exec</code></td>
134 </tr>
135 <tr>
Brock Janiczak003d47c2010-01-15 00:45:17 +0000[diff] [blame]136 <td><code>append</code></td>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]137 <td>If set to <code>true</code> and the execution data file already
Brock Janiczak003d47c2010-01-15 00:45:17 +0000[diff] [blame]138 exists, coverage data is appended to the existing file. If set to
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]139 <code>false</code>, an existing execution data file will be replaced.
140 </td>
141 <td><code>true</code></td>
142 </tr>
143 <tr>
Marc R. Hoffmanncf5345f2009-09-10 15:01:24 +0000[diff] [blame]144 <td><code>includes</code></td>
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]145 <td>A list of class names that should be included in execution analysis.
Marc R. Hoffmanncf5345f2009-09-10 15:01:24 +0000[diff] [blame]146 The list entries are separated by a vertical bar (<code>|</code>) and
147 may use wildcard characters (<code>*</code> and <code>?</code>).
148 Except for performance optimization or technical corner cases this
149 option is normally not required.
150 </td>
151 <td><code>*</code> (all classes)</td>
152 </tr>
153 <tr>
154 <td><code>excludes</code></td>
155 <td>A list of class names that should be excluded from execution analysis.
156 The list entries are separated by a vertical bar (<code>|</code>) and
157 may use wildcard characters (<code>*</code> and <code>?</code>).
158 Except for performance optimization or technical corner cases this
159 option is normally not required.
160 </td>
161 <td><i>empty</i> (no excluded classes)</td>
162 </tr>
163 <tr>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]164 <td><code>exclclassloader</code></td>
Marc R. Hoffmann2a6b5bf2009-08-11 12:54:36 +0000[diff] [blame]165 <td>A list of class loader names, that should be excluded from execution
166 analysis. The list entries are separated by a vertical bar
167 (<code>|</code>) and may use wildcard characters (<code>*</code> and
168 <code>?</code>). This option might be required in case of special
Marc R. Hoffmann57f9ab42009-08-24 10:52:42 +0000[diff] [blame]169 frameworks that conflict with JaCoCo code instrumentation, in
170 particular class loaders that do not have access to the Java runtime
171 classes.
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]172 </td>
173 <td><code>sun.reflect.DelegatingClassLoader</code></td>
174 </tr>
Brock Janiczakf2d6f882010-05-04 06:47:40 +0000[diff] [blame]175 <tr>
Marc R. Hoffmannadfa1182010-05-05 12:59:42 +0000[diff] [blame]176 <td><code>sessionid</code></td>
177 <td>A session identifier that is written with the execution data. Without
178 this parameter a random identifier is created by the agent.
179 </td>
180 <td><i>auto-generated</i></td>
181 </tr>
182 <tr>
Brock Janiczakf2d6f882010-05-04 06:47:40 +0000[diff] [blame]183 <td><code>dumponexit</code></td>
Marc R. Hoffmannadfa1182010-05-05 12:59:42 +0000[diff] [blame]184 <td>If set to <code>true</code> coverage data will be written on VM
185 shutdown.
186 </td>
Brock Janiczakf2d6f882010-05-04 06:47:40 +0000[diff] [blame]187 <td><code>true</code></td>
188 </tr>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]189 </tbody>
190</table>
191
192
Brock Janiczakd267c572010-01-28 09:53:54 +0000[diff] [blame]193<h2><a name="agent">Task <code>agent</code></a></h2>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]194
Marc R. Hoffmannd519add2009-08-11 11:09:29 +0000[diff] [blame]195<p>
196 If the <code>coverage</code> task is not suitable for your launch target, you
197 might alternatively use the <code>agent</code> task to create the Java agent
198 parameter. The following example defines a Ant property with the name
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]199 <code>agentvmparam</code> that can be directly used as a Java VM parameter:
Marc R. Hoffmannd519add2009-08-11 11:09:29 +0000[diff] [blame]200</p>
201
Marc R. Hoffmanna760f322010-03-10 22:23:52 +0000[diff] [blame]202<pre class="source lang-xml">
Marc R. Hoffmannd519add2009-08-11 11:09:29 +0000[diff] [blame]203<span class="nr"> 1</span>&lt;jacoco:agent property="agentvmparam"/>
204</pre>
205
206<p>
207 This task has the same attributes as the <code>coverage</code> task plus an
208 additional property to specify the target property name:
209</p>
210
211<table class="coverage">
212 <thead>
213 <tr>
214 <td>Attribute</td>
215 <td>Description</td>
216 <td>Default</td>
217 </tr>
218 </thead>
219 <tbody>
220 <tr>
Brock Janiczakd267c572010-01-28 09:53:54 +0000[diff] [blame]221 <td><code>enabled</code></td>
222 <td>When this variable is set to <code>false</code> the value of <code>property</code> will be set to an empty string, effectively
Marc R. Hoffmanne3ef2f32010-01-28 18:17:46 +0000[diff] [blame]223 disabling coverage instrumentation for any tasks that used the value.</td>
Brock Janiczakd267c572010-01-28 09:53:54 +0000[diff] [blame]224 <td><code>true</code></td>
225 </tr>
226 <tr>
Marc R. Hoffmannd519add2009-08-11 11:09:29 +0000[diff] [blame]227 <td><code>property</code></td>
228 <td>Name of the Ant property to set.</td>
229 <td><i>none (required)</i></td>
230 </tr>
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]231 <tr>
232 <td colspan="3"><i>All attributes of the <code>coverage</code> task.</i></td>
233 </tr>
Marc R. Hoffmannd519add2009-08-11 11:09:29 +0000[diff] [blame]234 </tbody>
235</table>
236
Brock Janiczak74c16592010-01-29 21:34:14 +0000[diff] [blame]237
238<h2><a name="merge">Task <code>merge</code></a></h2>
239
240<p>
241 This task can be used to merge the execution data from multiple test runs
242 into a single data store.
243</p>
244
Marc R. Hoffmanna760f322010-03-10 22:23:52 +0000[diff] [blame]245<pre class="source lang-xml">
Marc R. Hoffmann5c8a7032010-02-25 11:15:54 +0000[diff] [blame]246<span class="nr"> 1</span>&lt;jacoco:merge destfile="merged.exec"&gt;
247<span class="nr"> 2</span> &lt;fileset dir="executionData" includes="*.exec"/&gt;
248<span class="nr"> 3</span>&lt;/jacoco:merge&gt;
Brock Janiczak74c16592010-01-29 21:34:14 +0000[diff] [blame]249</pre>
250
251<p>
252 The task definition can contain any number of resource collection types and
253 has the following mandatory attribute:
254</p>
255
256<table class="coverage">
257 <thead>
258 <tr>
259 <td>Attribute</td>
260 <td>Description</td>
261 <td>Default</td>
262 </tr>
263 </thead>
264 <tbody>
265 <tr>
266 <td><code>destfile</code></td>
267 <td>Location to write the merged execution data.</td>
268 <td><i>none (required)</i></td>
269 </tr>
270 </tbody>
271</table>
272
273
Brock Janiczakd267c572010-01-28 09:53:54 +0000[diff] [blame]274<h2><a name="report">Task <code>report</code></a></h2>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]275
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]276<p>
277 Finally different reports can be created with the <code>report</code> task.
278 A report task declaration consists of different sections, two specify the
279 input data, additional ones specify the output formats:
280</p>
281
Marc R. Hoffmanna760f322010-03-10 22:23:52 +0000[diff] [blame]282<pre class="source lang-xml">
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]283<span class="nr"> 1</span>&lt;jacoco:report&gt;
284<span class="nr"> 2</span>
285<span class="nr"> 3</span> &lt;executiondata&gt;
286<span class="nr"> 4</span> &lt;file file="jacoco.exec"/&gt;
287<span class="nr"> 5</span> &lt;/executiondata&gt;
288<span class="nr"> 6</span>
289<span class="nr"> 7</span> &lt;structure name="Example Project"&gt;
290<span class="nr"> 8</span> &lt;classfiles&gt;
291<span class="nr"> 9</span> &lt;fileset dir="bin"/&gt;
292<span class="nr"> 10</span> &lt;/classfiles&gt;
293<span class="nr"> 11</span> &lt;sourcefiles encoding="UTF-8"&gt;
294<span class="nr"> 12</span> &lt;fileset dir="src"/&gt;
295<span class="nr"> 13</span> &lt;/sourcefiles&gt;
296<span class="nr"> 14</span> &lt;/structure&gt;
297<span class="nr"> 15</span>
298<span class="nr"> 16</span> &lt;html destdir="report"/&gt;
299<span class="nr"> 17</span>
300<span class="nr"> 18</span>&lt;/jacoco:report&gt;
301</pre>
302
303<p>
304 As you can see from the example above the <code>report</code> task is based
305 on several nested elements:
306</p>
307
308<h3>Element <code>executiondata</code></h3>
309
310<p>
311 Within this element Ant resources and resource collections can be specified,
312 that represent JaCoCo execution data files. If more than one execution data
313 file is specified, execution data is combined. A particular piece of code is
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]314 considered executed when it is marked as such in any of the input files.
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]315</p>
316
317<h3>Element <code>structure</code></h3>
318
319<p>
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]320 This element defines the report structure. It might contain the following
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]321 nested elements:
322</p>
323
324<ul>
325 <li><code>classfiles</code>: Container element for Ant resources and resource
Marc R. Hoffmannff7cd3a2010-04-06 08:54:29 +0000[diff] [blame]326 collections that can specify Java class files, ZIP archive files (jar, war,
327 ear etc.) or folders containing class files. Archives and folders are
328 searched recursively for class files.</li>
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]329 <li><code>sourcefiles</code>: Optional container element for Ant resources and
330 resource collections that specify corresponding source files. The element
331 has an optional attribute <code>encoding</code> to specify the character
332 encoding of the source files. If no encoding is given, the platform default
333 is used. If source files are specified, some report formats include
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]334 highlighted source code.</li>
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]335</ul>
336
337<p>
338 The structure can be refined with a hierarchy of <code>group</code> elements.
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]339 This way the coverage report can reflect different modules of a software
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]340 project. For each group element the corresponding class and source files can
Radek Libaad5fbc92009-10-26 13:26:53 +0000[diff] [blame]341 be specified separately. For example, the build script of JaCoCo itself
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]342 contains the following declaration to separate the different bundles in the
343 report (see the <a href="../coverage/index.html">resulting report</a>):
344</p>
345
Marc R. Hoffmanna760f322010-03-10 22:23:52 +0000[diff] [blame]346<pre class="source lang-xml">
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]347<span class="nr"> 1</span>&lt;structure name="JaCoCo"&gt;
348<span class="nr"> 2</span> &lt;group name="org.jacoco.core"&gt;
349<span class="nr"> 3</span> &lt;classfiles&gt;
350<span class="nr"> 4</span> &lt;path refid="bundle-org.jacoco.core"/&gt;
351<span class="nr"> 5</span> &lt;/classfiles&gt;
352<span class="nr"> 6</span> &lt;sourcefiles&gt;
353<span class="nr"> 7</span> &lt;fileset dir="${workspace.dir}/org.jacoco.core/src"/&gt;
354<span class="nr"> 8</span> &lt;/sourcefiles&gt;
355<span class="nr"> 9</span> &lt;/group&gt;
356<span class="nr"> 10</span> &lt;group name="org.jacoco.report"&gt;
357<span class="nr"> 11</span> &lt;classfiles&gt;
358<span class="nr"> 12</span> &lt;path refid="bundle-org.jacoco.report"/&gt;
359<span class="nr"> 13</span> &lt;/classfiles&gt;
360<span class="nr"> 14</span> &lt;sourcefiles&gt;
361<span class="nr"> 15</span> &lt;fileset dir="${workspace.dir}/org.jacoco.report/src"/&gt;
362<span class="nr"> 16</span> &lt;/sourcefiles&gt;
363<span class="nr"> 17</span> &lt;/group&gt;
364<span class="nr"> 18</span>
365<span class="nr"> 19</span> ...
366<span class="nr"> 20</span>
367<span class="nr"> 21</span>&lt;/structure&gt;
368</pre>
369
Marc R. Hoffmann722cad82010-03-09 18:22:33 +0000[diff] [blame]370<p>
371 Both <code>structure</code> and <code>group</code> elements have the following
372 mandatory attribute:
373</p>
374
375<table class="coverage">
376 <thead>
377 <tr>
378 <td>Attribute</td>
379 <td>Description</td>
380 <td>Default</td>
381 </tr>
382 </thead>
383 <tbody>
384 <tr>
385 <td><code>name</code></td>
386 <td>Name of the structure or group.</td>
387 <td><i>none (required)</i></td>
388 </tr>
389 </tbody>
390</table>
391
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]392<h3>Element <code>html</code></h3>
393
394<p>
Marc R. Hoffmann81f79202010-03-12 07:36:50 +0000[diff] [blame]395 Create a multi-page report in HTML format. The report can either be written as
396 multiple files into a directory or compressed into a single ZIP file.
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]397</p>
398
399<table class="coverage">
400 <thead>
401 <tr>
402 <td>Attribute</td>
403 <td>Description</td>
404 <td>Default</td>
405 </tr>
406 </thead>
407 <tbody>
408 <tr>
409 <td><code>destdir</code></td>
Marc R. Hoffmann81f79202010-03-12 07:36:50 +0000[diff] [blame]410 <td>Directory to create the report in. Either this property or
411 <code>destfile</code> has to be supplied.</td>
412 <td><i>none (required)</i></td>
413 </tr>
414 <tr>
415 <td><code>destfile</code></td>
416 <td>Zip file to create the report in. Either this property or
417 <code>destdir</code> has to be supplied.</td>
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]418 <td><i>none (required)</i></td>
419 </tr>
Marc R. Hoffmann2ecbea52009-09-03 14:19:11 +0000[diff] [blame]420 <tr>
421 <td><code>footer</code></td>
422 <td>Footer text for each report page.</td>
423 <td><i>No footer</i></td>
424 </tr>
Marc R. Hoffmann2becd332009-10-07 16:13:17 +0000[diff] [blame]425 <tr>
426 <td><code>encoding</code></td>
427 <td>Encoding of the generated HTML pages.</td>
428 <td><code>UTF-8</code></td>
429 </tr>
430 </tbody>
431</table>
432
433<h3>Element <code>xml</code></h3>
434
435<p>
436 Create a single-file report in XML format.
437</p>
438
439<table class="coverage">
440 <thead>
441 <tr>
442 <td>Attribute</td>
443 <td>Description</td>
444 <td>Default</td>
445 </tr>
446 </thead>
447 <tbody>
448 <tr>
Marc R. Hoffmann88b3f2f2009-10-19 16:10:35 +0000[diff] [blame]449 <td><code>destfile</code></td>
450 <td>Location to write the report file to.</td>
Marc R. Hoffmann2becd332009-10-07 16:13:17 +0000[diff] [blame]451 <td><i>none (required)</i></td>
452 </tr>
453 <tr>
454 <td><code>encoding</code></td>
455 <td>Encoding of the generated XML document.</td>
456 <td><code>UTF-8</code></td>
457 </tr>
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]458 </tbody>
459</table>
460
461<h3>Element <code>csv</code></h3>
462
463<p>
Marc R. Hoffmann2becd332009-10-07 16:13:17 +0000[diff] [blame]464 Create single-file report in CSV format.
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]465</p>
466
467<table class="coverage">
468 <thead>
469 <tr>
470 <td>Attribute</td>
471 <td>Description</td>
472 <td>Default</td>
473 </tr>
474 </thead>
475 <tbody>
476 <tr>
Marc R. Hoffmann88b3f2f2009-10-19 16:10:35 +0000[diff] [blame]477 <td><code>destfile</code></td>
478 <td>Location to write the report file to.</td>
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]479 <td><i>none (required)</i></td>
480 </tr>
Marc R. Hoffmanne17fd112009-10-19 15:27:04 +0000[diff] [blame]481 <tr>
482 <td><code>encoding</code></td>
483 <td>Encoding of the generated CSV document.</td>
484 <td><code>UTF-8</code></td>
485 </tr>
Marc R. Hoffmann2bb6fca2009-08-13 14:04:21 +0000[diff] [blame]486 </tbody>
487</table>
488
Marc R. Hoffmann17be2692010-02-02 05:44:47 +0000[diff] [blame]489</div>
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]490<div class="footer">
Marc R. Hoffmannb623ffb2010-05-06 19:48:08 +0000[diff] [blame^]491 <span class="right"><a href="@jacoco.home.url@">JaCoCo</a> @qualified.bundle.version@</span>
Marc R. Hoffmanndf6ff962010-04-09 15:31:22 +0000[diff] [blame]492 <a href="license.html">Copyright</a> &copy; @copyright.years@ Mountainminds GmbH &amp; Co. KG and Contributors
Marc R. Hoffmannf7d17522009-08-07 11:21:23 +0000[diff] [blame]493</div>
494
495</body>
496</html>