svn commit: r1595517 - in /maven/shared/trunk/maven-reporting-exec/src: main/java/org/apache/maven/reporting/exec/MavenReportExecution.java main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java site/apt/index.apt.vm

[hb...@apache.org]

Author: hboutemy
Date: Sat May 17 17:20:23 2014
New Revision: 1595517

URL: http://svn.apache.org/r1595517
Log:
improved explanations

Modified:
    maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java
    maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java
    maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt.vm

Modified: maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java?rev=1595517&r1=1595516&r2=1595517&view=diff
==============================================================================
--- maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java (original)
+++ maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecution.java Sat May 17 17:20:23 2014
@@ -24,12 +24,12 @@ import org.apache.maven.reporting.MavenR
 
 /**
  * <p>
- *   Since Maven 3, reporting plugin {@link MavenReport} are not anymore executed by Maven core.
- *   This class will store all necessary information for {@link MavenReport} execution:
+ *   Since Maven 3, reporting plugin {@link MavenReport} are not anymore prepared by Maven core.
+ *   This class will store all necessary information for {@link MavenReport} generation:
  *   <ul>
  *     <li>a {@link MavenReport},</li>
  *     <li>the goal name associated to the report,</li>
- *     <li>the associated {@link ClassLoader} for the Report Mojo execution,</li>
+ *     <li>the associated {@link ClassLoader} for the report generation,</li>
  *     <li>the {@link Plugin} associated to the {@link MavenReport}.</li>
  *   </ul> 
  * </p>

Modified: maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java?rev=1595517&r1=1595516&r2=1595517&view=diff
==============================================================================
--- maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java (original)
+++ maven/shared/trunk/maven-reporting-exec/src/main/java/org/apache/maven/reporting/exec/MavenReportExecutor.java Sat May 17 17:20:23 2014
@@ -25,14 +25,19 @@ import org.apache.maven.plugin.MojoExecu
 import org.apache.maven.reporting.MavenReport;
 
 /**
- * This component will build {@link MavenReport}s.
- * If a {@link MavenReport} needs to fork a lifecycle, this fork is executed.
+ * This component will execute (prepare) {@link MavenReport}s for later generation.
+ * If a {@link MavenReport} needs to fork a goal or a lifecycle phase, this fork is executed.
+ * <p>Notice that Maven Reports are classical {@link org.apache.maven.plugin.Mojo Mojos} implementing
+ * the {@link MavenReport} interface: when used as reports, their <code>Mojo.execute()</code> method is
+ * not used.</p> 
  *
  * @author Olivier Lamy
  */
 public interface MavenReportExecutor
 {
     /**
+     * Build the {@link MavenReport}s, with associated forked executions if necessary. 
+     * 
      * @param mavenReportExecutorRequest
      * @return Maven report execution results
      * @throws MojoExecutionException

Modified: maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt.vm?rev=1595517&r1=1595516&r2=1595517&view=diff
==============================================================================
--- maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt.vm (original)
+++ maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt.vm Sat May 17 17:20:23 2014
@@ -75,7 +75,7 @@ ${project.name}
 
   []
 
-  Maven 3 core makes an automatic transformation of <<<\<reporting\>>>> POM section to <<<maven-site-plugin>>>
-  configuration through the
+  Maven 3 core makes an automatic transformation of <<<\<reporting\>>>> POM section (which supports configuration inheritance)
+  to <<<maven-site-plugin>>>'s <<<reportPlugins>>> configuration through the
   {{{/ref/current/maven-model-builder/apidocs/org/apache/maven/model/plugin/ReportingConverter.html}ReportingConverter}}
   component.