svn commit: r439990 - /maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentInternalMojo.java

[vm...@apache.org]

Author: vmassol
Date: Mon Sep  4 02:22:10 2006
New Revision: 439990

URL: http://svn.apache.org/viewvc?view=rev&rev=439990
Log:
MCLOVER-47: review plugin documentation
Patch submitted by Franz Allan Valencia See
Reviewed by Vincent Massol

Fixed javadocs

Modified:
    maven/plugins/trunk/maven-clover-plugin/src/main/java/org/apache/maven/plugin/clover/CloverInstrumentInternalMojo.java

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?view=diff&rev=439990&r1=439989&r2=439990
==============================================================================
--- 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 Sep  4 02:22:10 2006
@@ -49,12 +49,20 @@
 public class CloverInstrumentInternalMojo extends AbstractCloverMojo
 {
     /**
+     * The directory where the Clover plugin will put all the files it generates during the build process. For
+     * example the Clover plugin will put instrumented sources somewhere inside this directory.
+     *  
      * @parameter
      * @required
      */
     private String cloverOutputDirectory;
 
     /**
+     * List of all artifacts for this Clover plugin provided by Maven. This is used internally to get a handle on
+     * the Clover JAR artifact.
+     *
+     * <p>Note: This is passed by Maven and must not be configured by the user.</p>
+     *
      * @parameter expression="${plugin.artifacts}"
      * @required
      */