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