maven-plugins/clover/xdocs/properties.xml

130 lines
4.0 KiB
XML

<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<author email="vmassol@apache.org">Vincent Massol</author>
<title>Maven Clover plugin properties</title>
</properties>
<body>
<section name="Maven Clover plugin properties">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
<tr>
<td>maven.clover.orderBy</td>
<td>Yes</td>
<td>
Specifies how the reports must be sorted:
<ul>
<li>Alpha -- Alpabetical </li>
<li>PcCoveredAsc -- Percent total coverage, ascending</li>
<li>PcCoveredDesc -- Percent total coverage, descending </li>
<li>ElementsCoveredAsc -- Total elements covered, ascending </li>
<li>ElementsCoveredDesc -- Total elements covered, descending </li>
</ul>
</td>
<td>
<code>PcCoveredAsc</code>
</td>
</tr>
<tr>
<td>maven.clover.instrument.tests</td>
<td>Yes</td>
<td>
Decides whether to instrument test classes.
</td>
<td>
<code>false</code>
</td>
</tr>
<tr>
<td>maven.clover.report.html</td>
<td>Yes</td>
<td>
Decides whether an HTML report will be generated.
</td>
<td>
<code>true</code>
</td>
</tr>
<tr>
<td>maven.clover.report.xml</td>
<td>Yes</td>
<td>
Decides whether an XML report will be generated.
</td>
<td>
<code>false</code>
</td>
</tr>
<tr>
<td>maven.clover.report.swing</td>
<td>Yes</td>
<td>
Decides whether a Swing report will be generated.
</td>
<td>
<code>false</code>
</td>
</tr>
<tr>
<td>maven.clover.database.dir</td>
<td>Yes</td>
<td>
Specifies the location of the Clover database.
</td>
<td>
<code>${maven.build.clover}/database</code>
</td>
</tr>
<tr>
<td>maven.clover.jar</td>
<td>Yes</td>
<td>
Allows the user to override the Clover jar. This is especially useful
as some Clover jars are license-signed for a specific project so you
might want to use different jars for different projects.
</td>
<td>
If not defined, the plugin uses a 30 day eval Clover jar which is
valid for open source projects.
</td>
</tr>
<tr>
<td>maven.clover.license.path</td>
<td>Yes</td>
<td>
Location of the Clover license. Users can override this property to
point to their own Clover license. By default uses a 30 day eval
license valid for open source projects. Set it to an empty value if
you wish to use Clover's other license loading mechanisms (Clover
looks next to clover.jar on the filesystem and in the classpath).
</td>
<td>
<code>${plugin.getDependencyPath('clover:clover-30day-eval')}</code>
</td>
</tr>
</table>
</section>
</body>
</document>