Author: dennisl
Date: Sat Feb 2 16:14:58 2008
New Revision: 617932
URL: http://svn.apache.org/viewvc?rev=617932&view=rev
Log:
[MCHECKSTYLE-82] Clarify usage of outputDirectory parameter
Submitted by: Benjamin Bentmann
Reviewed by: Dennis Lundberg
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java?rev=617932&r1=617931&r2=617932&view=diff
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
(original)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/main/java/org/apache/maven/plugin/checkstyle/CheckstyleReport.java
Sat Feb 2 16:14:58 2008
@@ -112,7 +112,10 @@
private boolean skip;
/**
- * Specifies the directory where the report will be generated
+ * The output directory for the report. Note that this parameter is only
+ * evaluated if the goal is run directly from the command line. If the goal
+ * is run indirectly as part of a site generation, the output directory
+ * configured in Maven Site Plugin is used instead.
*
* @parameter default-value="${project.reporting.outputDirectory}"
* @required
