<?xml version="1.0" encoding="UTF-8"?>

  <!-- 
/*
 * 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>
    <title>Maven Clover plugin goals</title>
    <author email="dion@apache.org">dIon Gillard</author>
    <author email="vmassol@apache.org">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>
          This is the default goal. Does the same as the
          <code>clover:report</code> goal.
        </description>
      </goal>
      <goal>
        <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>
</document>