Bommels05/maven-plugins
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Reworked documentation

Browse Source 
- Prepare to release version 1.3


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114422 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
vmassol committed 2003-11-28 08:12:14 +00:00
1 parent b47bde6d6d
commit ddd2d9516c
9 files changed
+110 -311
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

clover/xdocs/properties.xml
+52 -45
View File
@@ -2,63 +2,70 @@
<document>
<properties>
<author email="vmassol@octo.com">Vincent Massol</author>
<title>Maven Clover Plug-in Properties Documentation</title>
<author email="vmassol@apache.org">Vincent Massol</author>
<title>Maven Clover plugin properties</title>
</properties>
<body>
<section name="Maven Clover Plug-in Properties">
<p>
The following is an overview of the various properties (and
default values) used by the Maven Clover Plug-in <a
href="build-file.html">build file</a>. Most of these
properties are optional and have defaults; however, there are
mandatory properties that must be set as described in this document.
</p>
<p>
These properties can be overridden to change the default behavior of
the Maven Clover Plug-in. If you need to override any of these
properties, please refer to the
<a href="../../start/integrate.html">Integration</a>
document for the preferred method of setting properties in your project.
</p>
<section name="Maven Clover plugin properties">
<table>
<tr><th>Section</th><th>Description</th></tr>
<tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
<tr>
<td><a href="#Misc Settings">Misc</a></td>
<td>maven.clover.orderBy</td>
<td>Yes</td>
<td>
These properties specify various settings that control the
behaviour of the Clover Plug-in.
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>
</table>
</section>
<section name="Misc Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td><a name="maven.clover.database.dir">maven.clover.database.dir</a></td>
<td>No</td>
<td>maven.clover.report.html</td>
<td>Yes</td>
<td>
Specifies the location of the Clover database. The default value is
<code>${maven.build.dir}/clover/database</code>.
Decides whether an HTML report will be generated.
</td>
</tr>
<td>
<code>true</code>
</td>
</tr>
<tr>
<td>maven.clover.orderBy</td>
<td>No</td>
<td>
Specifies the type of report to generate:
<ul>
<li>Alpha -- Alpabetical </li>
<li>PcCoveredAsc -- Percent total coverage, ascending <b>(default)</b></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>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>
</table>
</section>