Author: vmassol
Date: Mon Jun 26 01:10:02 2006
New Revision: 417137
URL: http://svn.apache.org/viewvc?rev=417137&view=rev
Log:
Improved javadoc for better web site documentation
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverAggregateMojo.java
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverCheckMojo.java
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentInternalMojo.java
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentMojo.java
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverLogMojo.java
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverReportMojo.java
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverSaveHistoryMojo.java
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/internal/AbstractCloverMojo.java
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverAggregateMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverAggregateMojo.java?rev=417137&r1=417136&r2=417137&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverAggregateMojo.java
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverAggregateMojo.java
Mon Jun 26 01:10:02 2006
@@ -24,6 +24,8 @@
/**
* The projects in the reactor for aggregation report.
*
+ * <p>Note: This is passed by Maven and must not be configured by the
user.</p>
+ *
* @parameter expression="${reactorProjects}"
* @readonly
*/
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverCheckMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverCheckMojo.java?rev=417137&r1=417136&r2=417137&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverCheckMojo.java
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverCheckMojo.java
Mon Jun 26 01:10:02 2006
@@ -37,6 +37,8 @@
public class CloverCheckMojo extends AbstractCloverMojo
{
/**
+ * The Test Percentage Coverage (TPC) threshold under which the plugin
will report an error and fail the build.
+ *
* @parameter default-value="70%"
* @required
*/
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentInternalMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentInternalMojo.java?rev=417137&r1=417136&r2=417137&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentInternalMojo.java
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentInternalMojo.java
Mon Jun 26 01:10:02 2006
@@ -34,7 +34,8 @@
/**
* Instrument source roots.
*
- * Note: Do not call this MOJO directly. It is meant to be called in a forked
lifecycle by the other MOJOs.
+ * <p><b>Note: Do not call this MOJO directly. It is meant to be called in a
custom forked lifecycle by the other
+ * MOJOs.</b></p>
*
* @goal instrumentInternal
* @phase generate-sources
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentMojo.java?rev=417137&r1=417136&r2=417137&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentMojo.java
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentMojo.java
Mon Jun 26 01:10:02 2006
@@ -22,10 +22,11 @@
* Instrument all sources using Clover and forks a custom lifecycle to execute
project's tests on the instrumented code
* so that a Clover database is created.
*
- * Note: We're forking a lifecycle because we don't want the Clover
instrumentation to affect the main lifecycle build.
- * This will prevent instrumented sources to be put in production by error.
Thus running <code>mvn install</code> on
- * a project where this <code>instrument</code> goal has been specified will
run the build twice: once for building the
- * project as usual and another time for instrumenting the sources with Clover
and generating the Clover database.
+ * <p>Note: We're forking a lifecycle because we don't want the Clover
instrumentation to affect the main lifecycle
+ * build. This will prevent instrumented sources to be put in production by
error. Thus running <code>mvn install</code>
+ * on a project where this <code>instrument</code> goal has been specified
will run the build twice: once for building
+ * the project as usual and another time for instrumenting the sources with
Clover and generating the Clover
+ * database.</p>
*
* @goal instrument
* @execute phase="install" lifecycle="clover"
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverLogMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverLogMojo.java?rev=417137&r1=417136&r2=417137&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverLogMojo.java
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverLogMojo.java
Mon Jun 26 01:10:02 2006
@@ -29,10 +29,8 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Vincent Massol</a>
* @version $Id$
- *
*/
-public class CloverLogMojo
- extends AbstractCloverMojo
+public class CloverLogMojo extends AbstractCloverMojo
{
public void execute()
throws MojoExecutionException
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverReportMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverReportMojo.java?rev=417137&r1=417136&r2=417137&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverReportMojo.java
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverReportMojo.java
Mon Jun 26 01:10:02 2006
@@ -33,8 +33,8 @@
* is an external report generated by Clover itself. If the project generating
the report is a top level project and
* if the <code>aggregate</code> configuration element is set to true then an
aggregated report will also be created.
*
- * Note: This report mojo should be an @aggregator and the
<code>clover:aggregate</code> mojo shouldn't exist. This
- * is a limitation of the site plugin which doesn't support @aggregator
reports...
+ * <p>Note: This report mojo should be an @aggregator and the
<code>clover:aggregate</code> mojo shouldn't exist. This
+ * is a limitation of the site plugin which doesn't support @aggregator
reports...</p>
*
* @goal clover
*
@@ -71,6 +71,11 @@
private File outputDirectory;
/**
+ * The location where historical Clover data will be saved.
+ *
+ * <p>Note: It's recommended to modify the location of this directory so
that it points to a more permanent
+ * location as the <code>${project.build.directory}</code> directory is
erased when the project is cleaned.</p>
+ *
* @parameter default-value="${project.build.directory}/clover/history"
* @required
*/
@@ -85,50 +90,53 @@
private int flushInterval;
/**
- * If true we'll wait 2*flushInterval to ensure coverage data is flushed
to the Clover
- * database before running any query on it.
+ * If true we'll wait 2*flushInterval to ensure coverage data is flushed
to the Clover database before running
+ * any query on it.
*
- * Note: The only use case where you would want to turn this off is if
you're running your
- * tests in a separate JVM. In that case the coverage data will be flushed
by default upon
- * the JVM shutdown and there would be no need to wait for the data to be
flushed. As we
- * can't control whether users want to fork their tests or not, we're
offering this parameter
- * to them.
+ * <p>Note: The only use case where you would want to turn this off is if
you're running your tests in a separate
+ * JVM. In that case the coverage data will be flushed by default upon the
JVM shutdown and there would be no need
+ * to wait for the data to be flushed. As we can't control whether users
want to fork their tests or not, we're
+ * offering this parameter to them.</p>
*
* @parameter default-value="true"
*/
private boolean waitForFlush;
/**
- * Decide whether to generate an HTML report.
+ * Decide whether to generate an HTML report or not.
* @parameter default-value="true"
*/
private boolean generateHtml;
/**
- * Decide whether to generate a PDF report.
+ * Decide whether to generate a PDF report or not.
* @parameter default-value="false"
*/
private boolean generatePdf;
/**
- * Decide whether to generate a XML report.
+ * Decide whether to generate a XML report or not.
* @parameter default-value="false"
*/
private boolean generateXml;
/**
- * Decide whether to generate a Clover historical report.
+ * Decide whether to generate a Clover historical report or not.
* @parameter default-value="false"
*/
private boolean generateHistorical;
/**
+ * <p>Note: This is passed by Maven and must not be configured by the
user.</p>
+ *
* @component
*/
private Renderer siteRenderer;
/**
- * The Maven project.
+ * The Maven project instance for the executing project.
+ *
+ * <p>Note: This is passed by Maven and must not be configured by the
user.</p>
*
* @parameter expression="${project}"
* @required
@@ -138,6 +146,8 @@
/**
* The projects in the reactor for aggregation report.
+ *
+ * <p>Note: This is passed by Maven and must not be configured by the
user.</p>
*
* @parameter expression="${reactorProjects}"
* @readonly
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverSaveHistoryMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverSaveHistoryMojo.java?rev=417137&r1=417136&r2=417137&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverSaveHistoryMojo.java
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverSaveHistoryMojo.java
Mon Jun 26 01:10:02 2006
@@ -33,6 +33,11 @@
public class CloverSaveHistoryMojo extends AbstractCloverMojo
{
/**
+ * The location where historical Clover data will be saved.
+ *
+ * <p>Note: It's recommended to modify the location of this directory so
that it points to a more permanent
+ * location as the <code>${project.build.directory}</code> directory is
erased when the project is cleaned.</p>
+ *
* @parameter default-value="${project.build.directory}/clover/history"
* @required
*/
Modified:
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/internal/AbstractCloverMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/internal/AbstractCloverMojo.java?rev=417137&r1=417136&r2=417137&view=diff
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/internal/AbstractCloverMojo.java
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/internal/AbstractCloverMojo.java
Mon Jun 26 01:10:02 2006
@@ -24,9 +24,17 @@
import java.io.IOException;
import java.io.File;
+/**
+ * Common code for all Clover plugin build Mojos.
+ *
+ * @author <a href="mailto:[EMAIL PROTECTED]">Vincent Massol</a>
+ * @version $Id$
+ */
public abstract class AbstractCloverMojo extends AbstractMojo
{
/**
+ * The location of the <a
href="http://cenqua.com/clover/doc/adv/database.html";>Clover database</a>.
+ *
* @parameter expression="${project.build.directory}/clover/clover.db"
* @required
*/
@@ -77,10 +85,10 @@
* If true we'll wait 2*flushInterval to ensure coverage data is flushed
to the Clover database before running
* any query on it.
*
- * Note: The only use case where you would want to turn this off is if
you're running your tests in a separate JVM.
- * In that case the coverage data will be flushed by default upon the JVM
shutdown and there would be no need to
- * wait for the data to be flushed. As we can't control whether users want
to fork their tests or not, we're
- * offering this parameter to them.
+ * <p>Note: The only use case where you would want to turn this off is if
you're running your tests in a separate
+ * JVM. In that case the coverage data will be flushed by default upon the
JVM shutdown and there would be no need
+ * to wait for the data to be flushed. As we can't control whether users
want to fork their tests or not, we're
+ * offering this parameter to them.</p>
*
* @parameter default-value="true"
*/
@@ -95,6 +103,10 @@
private String jdk;
/**
+ * The Maven project instance for the executing project.
+ *
+ * <p>Note: This is passed by Maven and must not be configured by the
user.</p>
+ *
* @parameter expression="${project}"
* @required
*/
