maven-plugins/clover/xdocs/properties.xml

275 lines
8.2 KiB
XML

<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2005 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.report.pdf</td>
<td>Yes</td>
<td>
Decides whether a PDF report will be generated.
</td>
<td>
<code>false</code>
</td>
</tr>
<tr>
<td>maven.clover.database</td>
<td>Yes</td>
<td>
Specifies the location of the Clover database.
</td>
<td>
<code>${maven.clover.build}/database/clover_coverage.db</code>
</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 an 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.resources}/clover.license</code>
</td>
</tr>
<tr>
<td>maven.clover.execute.during.report</td>
<td>Yes</td>
<td>
Controls whether or not the <code>clover-report</code>
goal builds Cloverify the sources and execute the tests.
</td>
<td>
<code>true</code>
</td>
</tr>
<tr>
<td>maven.clover.includes</td>
<td>Yes</td>
<td>
List of files to include in the Cloverification.
</td>
<td>
<code>**/*.java</code>
</td>
</tr>
<tr>
<td>maven.clover.excludes</td>
<td>Yes</td>
<td>
List of files to exclude from the Cloverification.
</td>
<td>
<code></code>
</td>
</tr>
<tr>
<td>maven.clover.target</td>
<td>Yes</td>
<td>
Test coverage % under which the build will fail when
<code>clover:check</code> is called.
</td>
<td>
<code>50%</code>
</td>
</tr>
<tr>
<td>maven.clover.packages</td>
<td>Yes</td>
<td>
Comma-separated list of packages that you wish to check for
test coverage % when <code>clover:check</code> is called.
</td>
<td>
N/A
</td>
</tr>
<tr>
<td>maven.clover.targets</td>
<td>Yes</td>
<td>
Comma-separated list of test coverage % that you wish to check for
each packages specified by <code>maven.clover.packages</code> when
<code>clover:check</code> is called.
</td>
<td>
N/A
</td>
</tr>
<tr>
<td>maven.clover.context.block.names</td>
<td>Yes</td>
<td>
Comma-separated list of Clover-defined block contexts to filter
from the Clover coverage report.
Example: <code>maven.clover.context.block.names = static, method</code>.
</td>
<td>
N/A
</td>
</tr>
<tr>
<td>maven.clover.context.method.names</td>
<td>Yes</td>
<td>
Comma-separated list of user-defined method contexts to filter from
the Clover coverage report.
Example: <code>maven.clover.context.method.names = name1, name2</code>.
</td>
<td>
N/A
</td>
</tr>
<tr>
<td>maven.clover.context.method.regexps</td>
<td>Yes</td>
<td>
Regexps associated with <code>maven.clover.context.method.names</code>.
Example: <code>maven.clover.context.method.regexps = regexp1, regexp2</code>.
</td>
<td>
N/A
</td>
</tr>
<tr>
<td>maven.clover.context.statement.names</td>
<td>Yes</td>
<td>
Comma-separated list of user-defined statement contexts to filter from
the Clover coverage report.
Example: <code>maven.clover.context.statement.names = name3, name4</code>.
</td>
<td>
N/A
</td>
</tr>
<tr>
<td>maven.clover.context.statement.regexps</td>
<td>Yes</td>
<td>
Regexps associated with <code>maven.clover.context.statement.names</code>.
Example: <code>maven.clover.context.statement.regexps = regexp3, regexp4</code>.
</td>
<td>
N/A
</td>
</tr>
<tr>
<td>maven.clover.history.dir</td>
<td>Yes</td>
<td>
Directory where Clover history data are saved. If you wish to save
your history point data so that they are not erased, point this
directory to a safe place that will not be deleted by a
"maven clean". In the future we will try to implement saving the
history points in the Maven repositories.
</td>
<td>
${maven.clover.build}/history
</td>
</tr>
<tr>
<td>maven.clover.merge.databases</td>
<td>Yes</td>
<td>
List of databases to include in the merge when using the
<code>clover:merge</code> goal.
</td>
<td>
**/clover_coverage.db
</td>
</tr>
</table>
</section>
</body>
</document>