vmassol 2003/11/28 00:12:14
Modified: clover/xdocs properties.xml navigation.xml index.xml
goals.xml changes.xml
clover project.xml
Removed: clover/xdocs futures.xml build-file.xml dirlayout.xml
Log:
- Reworked documentation
- Prepare to release version 1.3
Revision Changes Path
1.5 +52 -45 maven-plugins/clover/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven-plugins/clover/xdocs/properties.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- properties.xml 24 Sep 2003 05:14:53 -0000 1.4
+++ properties.xml 28 Nov 2003 08:12:14 -0000 1.5
@@ -2,63 +2,70 @@
<document>
<properties>
- <author email="[EMAIL PROTECTED]">Vincent Massol</author>
- <title>Maven Clover Plug-in Properties Documentation</title>
+ <author email="[EMAIL PROTECTED]">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>
+ Decides whether an HTML report will be generated.
+ </td>
<td>
- Specifies the location of the Clover database. The default value is
- <code>${maven.build.dir}/clover/database</code>.
+ <code>true</code>
</td>
- </tr>
+ </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>
1.3 +5 -5 maven-plugins/clover/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven-plugins/clover/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 19 Mar 2003 05:54:19 -0000 1.2
+++ navigation.xml 28 Nov 2003 08:12:14 -0000 1.3
@@ -9,11 +9,11 @@
<item name="Clover" href="http://www.thecortex.net/clover/"/>
</links>
<menu name="Overview">
- <item name="Build File" href="/build-file.html"/>
- <item name="Goals" href="/goals.html"/>
- <item name="Properties" href="/properties.html"/>
- <item name="Directory Layout" href="/dirlayout.html"/>
- <item name="Futures" href="/futures.html"/>
+ <item name="Goals" href="/goals.html"/>
+ <item name="Properties" href="/properties.html"/>
+ </menu>
+ <menu name="Downloads">
+ <item name="Clover Plugin 1.3"
href="http://www.ibiblio.org/maven/maven/plugins/maven-clover-plugin-1.3.jar"/>
</menu>
</body>
</project>
1.3 +8 -54 maven-plugins/clover/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven-plugins/clover/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 5 Apr 2003 23:29:17 -0000 1.2
+++ index.xml 28 Nov 2003 08:12:14 -0000 1.3
@@ -3,67 +3,21 @@
<properties>
<title>Maven Clover Plug-in</title>
- <author email="[EMAIL PROTECTED]">Vincent Massol</author>
+ <author email="[EMAIL PROTECTED]">Vincent Massol</author>
</properties>
<body>
- <section name="Maven Clover Plug-in">
+ <section name="Maven Clover plugin">
<p>
- This document provides an overview of the Maven Clover Plug-in.
+ The Clover Plug-in is the place where
+ <a href="http://www.thecortex.net/clover/";>Clover</a> tools are found
+ in Maven.
</p>
<p>
- The documents presented here are references, if you are looking
- for more verbose usage material, please refer to the <a
- href="../../../start/index.html">Getting Started</a> section.
+ Clover is a tool that generates Test Coverage reports. It is free for
+ non-commercial use. If your project is a commercial project you will
+ need to get a license for the Clover jar before using this plugin.
</p>
- <subsection name="What it is">
- <p>
- The Clover Plug-in is the place where <a
- href="http://www.thecortex.net/clover/";>Clover</a> tools are found
- in Maven.
- </p>
- <p>
- Clover is a tool that generates Test Coverage reports. It is free for
- non-commercial use. If your project is a commercial project you will
- need to get a license for the Clover jar before using this Plug-in.
- </p>
- </subsection>
- <subsection name="Overview of the Clover Plug-in Reference Documentation">
- <table>
- <tr><th>Document</th><th>Description</th></tr>
- <tr><td><a href="build-file.html">Build File</a></td>
- <td>
- This document provides detailed information on the various
- targets that are available as part of the Maven Clover Plug-in.
- These targets can be delegated to by your project's local
- build file.
- </td>
- </tr>
- <tr><td><a href="properties.html">Properties</a></td>
- <td>
- The behavior of the Maven Clover Plug-in can be altered via
- properties. This document describes each property
- available as the default used.
- </td>
- </tr>
- <tr><td><a href="dirlayout.html">Directory Layout</a></td>
- <td>
- The preferred directory layout structure is documented
- here. This is a useful document if you are trying to
- determine what a particular component of your directory
- hierarchy is used for.
- </td>
- </tr>
- <tr><td><a href="futures.html">Futures</a></td>
- <td>
- These are the current thoughts on additional items
- that could or should be added to the plug-in.
- They may or may not make it to an actual task list of a
- developer.
- </td>
- </tr>
- </table>
- </subsection>
</section>
</body>
</document>
1.2 +28 -12 maven-plugins/clover/xdocs/goals.xml
Index: goals.xml
===================================================================
RCS file: /home/cvs/maven-plugins/clover/xdocs/goals.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- goals.xml 24 Jan 2003 03:45:04 -0000 1.1
+++ goals.xml 28 Nov 2003 08:12:14 -0000 1.2
@@ -2,26 +2,42 @@
<document>
<properties>
- <title>Maven clover Plug-in Goals</title>
+ <title>Maven Clover plugin goals</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
+ <author email="[EMAIL PROTECTED]">Vincent Massol</author>
</properties>
<body>
+ <section name="Registering a Clover report">
+ <p>
+ The typical way to use the Clover plugin is by registering a Clover
+ report in your <code>project.xml</code>:
+ </p>
+<source><![CDATA[
+ <reports>
+ <report>maven-clover-plugin</report>
+ [...]
+ </reports>
+]]></source>
+ </section>
<goals>
<goal>
<name>clover</name>
- <description>Generate HTML test coverage reports with Clover</description>
+ <description>
+ This is the default goal. Does the same as the
+ <code>clover:report</code> goal.
+ </description>
</goal>
<goal>
- <name>clover:html-report</name>
- <description>Generate HTML test coverage reports with Clover</description>
- </goal>
- <goal>
- <name>clover:on</name>
- <description>Create the needed directory structure</description>
- </goal>
- <goal>
- <name>clover:swing-report</name>
- <description>Generate Swing test coverage reports with Clover</description>
+ <name>clover:report</name>
+ <description>
+ Generate Clover test coverage reports with Clover. There are 3
+ possible reports: HTML, XML or Swing. Whether a report is generated
+ is controller by the <code>maven.clover.report.[report name]</code>
+ <a href="properties.html">properties</a>. Before generating a
+ report, the goal recompiles the source code with Clover and reruns
+ the unit tests. The generated reports show exactly what lines of
+ your code were exercised by your tests.
+ </description>
</goal>
</goals>
</body>
1.14 +4 -1 maven-plugins/clover/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/maven-plugins/clover/xdocs/changes.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- changes.xml 16 Nov 2003 15:25:08 -0000 1.13
+++ changes.xml 28 Nov 2003 08:12:14 -0000 1.14
@@ -8,7 +8,10 @@
<body>
- <release version="1.3" date="in CVS">
+ <release version="1.3" date="2003-11-28">
+ <action dev="vmassol" type="add">
+ Added unit tests for the plugin and reworked the documentation.
+ </action>
<action dev="vmassol" type="update">
Upgraded to Clover 1.2.3.
</action>
1.25 +13 -3 maven-plugins/clover/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/maven-plugins/clover/project.xml,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- project.xml 16 Nov 2003 10:03:02 -0000 1.24
+++ project.xml 28 Nov 2003 08:12:14 -0000 1.25
@@ -5,7 +5,7 @@
<pomVersion>3</pomVersion>
<id>maven-clover-plugin</id>
<name>Maven Clover Plug-in</name>
- <currentVersion>1.3-SNAPSHOT</currentVersion>
+ <currentVersion>1.3</currentVersion>
<description/>
<shortDescription>Produce Clover reports</shortDescription>
<url>http://maven.apache.org/reference/plugins/clover/</url>
@@ -24,7 +24,7 @@
<version>
<id>1.3</id>
<name>1.3</name>
- <tag>HEAD</tag>
+ <tag>MAVEN_CLOVER_1_3</tag>
</version>
</versions>
<developers>
@@ -86,11 +86,21 @@
</developers>
<dependencies>
<dependency>
- <id>clover</id>
+ <groupId>clover</groupId>
+ <artifactId>clover</artifactId>
<version>1.2.3</version>
<properties>
<classloader>root</classloader>
</properties>
</dependency>
</dependencies>
+ <reports>
+ <report>maven-changes-plugin</report>
+ <report>maven-changelog-plugin</report>
+ <report>maven-file-activity-plugin</report>
+ <report>maven-developer-activity-plugin</report>
+ <report>maven-file-activity-plugin</report>
+ <report>maven-license-plugin</report>
+ <report>maven-linkcheck-plugin</report>
+ </reports>
</project>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
