Author: brett
Date: Sat Apr 8 08:29:31 2006
New Revision: 392547
URL: http://svn.apache.org/viewcvs?rev=392547&view=rev
Log:
add extra documentation on fields
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java?rev=392547&r1=392546&r2=392547&view=diff
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java
(original)
+++
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java
Sat Apr 8 08:29:31 2006
@@ -36,23 +36,31 @@
extends AbstractMavenReport
{
/**
+ * The output directory for the intermediate XML report.
+ *
* @parameter expression="${project.build.directory}"
* @required
*/
protected File targetDirectory;
/**
+ * The output directory for the final HTML report.
+ *
* @parameter expression="${project.reporting.outputDirectory}"
* @required
*/
protected String outputDirectory;
/**
+ * Site rendering component for generating the HTML report.
+ *
* @component
*/
private SiteRenderer siteRenderer;
/**
+ * The project to analyse.
+ *
* @parameter expression="${project}"
* @required
* @readonly
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java?rev=392547&r1=392546&r2=392547&view=diff
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java
(original)
+++
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/AbstractPmdViolationCheckMojo.java
Sat Apr 8 08:29:31 2006
@@ -21,13 +21,15 @@
extends AbstractMojo
{
/**
+ * The location of the XML report to check, as generated by the PMD report.
+ *
* @parameter expression="${project.build.directory}"
* @required
*/
private File targetDirectory;
/**
- * Fail on violation?
+ * Whether to fail the build if the validation check fails.
*
* @parameter expression="${failOnViolation}" default-value="true"
* @required
@@ -35,7 +37,7 @@
private boolean failOnViolation;
/**
- * The project language.
+ * The project language, for determining whether to run the report.
*
* @parameter expression="${project.artifact.artifactHandler.language}"
* @required
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java?rev=392547&r1=392546&r2=392547&view=diff
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java
(original)
+++
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdReport.java
Sat Apr 8 08:29:31 2006
@@ -43,9 +43,11 @@
extends AbstractPmdReport
{
/**
- * @parameter expression="${minimumTokens}"
+ * The minimum number of tokens that need to be duplicated before it
causes a violation.
+ *
+ * @parameter expression="${minimumTokens}" default-value="100"
*/
- private int minimumTokens = 100;
+ private int minimumTokens;
/**
* @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java?rev=392547&r1=392546&r2=392547&view=diff
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java
(original)
+++
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/CpdViolationCheckMojo.java
Sat Apr 8 08:29:31 2006
@@ -20,7 +20,7 @@
import org.apache.maven.plugin.MojoFailureException;
/**
- * Perform a violation check against the last pmd run to see if there are any
violations.
+ * Fail the build if there were any CPD violations in the source code.
*
* @goal cpd-check
* @phase verify
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java?rev=392547&r1=392546&r2=392547&view=diff
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
(original)
+++
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdReport.java
Sat Apr 8 08:29:31 2006
@@ -65,13 +65,16 @@
{
/**
- * @parameter expression="${targetJdk}
+ * The target JDK to analyse based on. Should match the target directory
for the compiler plugin. Valid values are
+ * currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code>.
+ *
+ * @parameter expression="${targetJdk}"
*/
private String targetJdk;
/**
- * The PMD rulesets to use. <a
href="http://pmd.sourceforge.net/rules/index.html";>Stock Rulesets</a>
- * Defaults to the basic, imports and unusedcode rulesets.
+ * The PMD rulesets to use. See the <a
href="http://pmd.sourceforge.net/rules/index.html";>Stock Rulesets</a> for a
+ * list of some included. Defaults to the basic, imports and unusedcode
rulesets.
*
* @parameter
*/
@@ -86,7 +89,7 @@
private String sourceEncoding;
/**
- * Files to exclude from checking. Can contain wildcards and double
wildcards.
+ * A list of files to exclude from checking. Can contain wildcards and
double wildcards.
*
* @parameter
*/
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java
URL:
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java?rev=392547&r1=392546&r2=392547&view=diff
==============================================================================
---
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java
(original)
+++
maven/plugins/trunk/maven-pmd-plugin/src/main/java/org/apache/maven/plugin/pmd/PmdViolationCheckMojo.java
Sat Apr 8 08:29:31 2006
@@ -20,7 +20,7 @@
import org.apache.maven.plugin.MojoFailureException;
/**
- * Perform a violation check against the last pmd run to see if there are any
violations.
+ * Fail the build if there were any PMD violations in the source code.
*
* @goal check
* @phase verify
