svn commit: r616586 - /maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java

[br...@apache.org]

Author: brianf
Date: Tue Jan 29 18:02:44 2008
New Revision: 616586

URL: http://svn.apache.org/viewvc?rev=616586&view=rev
Log:
MNG-3369

Modified:
    maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java

Modified: maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java?rev=616586&r1=616585&r2=616586&view=diff
==============================================================================
--- maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java (original)
+++ maven/shared/trunk/maven-reporting-impl/src/main/java/org/apache/maven/reporting/AbstractMavenReport.java Tue Jan 29 18:02:44 2008
@@ -187,7 +187,17 @@
     protected abstract Renderer getSiteRenderer();
 
     /**
-     * @return the output directory path.
+     * The output directory when the mojo is run directly from the command line. Implementors should use this method to
+     * return the value of a mojo parameter that the user may use to customize the output directory.
+     * <br/>
+     * <strong>Note:</strong>
+     * When the mojo is run as part of a site generation, Maven will set the effective output directory via
+     * {@link org.apache.maven.reporting.MavenReport#setReportOutputDirectory(java.io.File)}. In this case, the return
+     * value of this method is irrelevant. Therefore, developers should always call {@link #getReportOutputDirectory()}
+     * to get the effective output directory for the report. The later method will eventually fallback to this method
+     * if the mojo is not run as part of a site generation.
+     * 
+     * @return The path to the output directory as specified in the plugin configuration for this report.
      */
     protected abstract String getOutputDirectory();