svn commit: r1598306 - 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: Thu May 29 14:37:54 2014
New Revision: 1598306

URL: http://svn.apache.org/r1598306
Log:
explanations precision

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=1598306&r1=1598305&r2=1598306&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 Thu May 29 14:37:54 2014
@@ -24,8 +24,8 @@ import org.apache.maven.reporting.MavenR
 
 /**
  * <p>
- *   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:
+ *   Since Maven 3, reporting plugins (ie {@link MavenReport}s) are not anymore prepared by Maven core.
+ *   This class will store all necessary information for later {@link MavenReport} generation/execution:
  *   <ul>
  *     <li>a {@link MavenReport},</li>
  *     <li>the goal name associated to the report,</li>
@@ -34,11 +34,12 @@ import org.apache.maven.reporting.MavenR
  *   </ul> 
  * </p>
  * <p>
- *   With this, it's possible to execute the {@link MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)}
- *   method, setting the current {@link Thread} classLoader first with {@link #classLoader}
+ *   With this bean, a plugin wanting to generate a report (= <i>"execute"</i> the report) has to call the
+ *   {@link MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)}
+ *   method, setting the current {@link Thread} classLoader first with {@link #classLoader}.
  * </p>
  * <p>
- *   This bean will be instantiated by {@link MavenReportExecutor}.
+ *   This bean is instantiated by {@link MavenReportExecutor}.
  * </p>
  * 
  * @author Olivier Lamy

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=1598306&r1=1598305&r2=1598306&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 Thu May 29 14:37:54 2014
@@ -25,11 +25,11 @@ import org.apache.maven.plugin.MojoExecu
 import org.apache.maven.reporting.MavenReport;
 
 /**
- * This component will execute (prepare) {@link MavenReport}s for later generation.
+ * This component will 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> 
+ * not to be used but <code>MavenReport.generate()</code>.</p> 
  *
  * @author Olivier Lamy
  */
@@ -39,7 +39,7 @@ public interface MavenReportExecutor
      * Build the {@link MavenReport}s, with associated forked executions if necessary. 
      * 
      * @param mavenReportExecutorRequest
-     * @return Maven report execution results
+     * @return a list or prepared Maven report executions
      * @throws MojoExecutionException
      */
     List<MavenReportExecution> buildMavenReports( MavenReportExecutorRequest mavenReportExecutorRequest )

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=1598306&r1=1598305&r2=1598306&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 Thu May 29 14:37:54 2014
@@ -28,7 +28,7 @@
 
 ${project.name}
 
-  Classes to manage report plugin executions with Maven 3, through
+  Classes to prepare report plugins execution with Maven 3, through
   {{{./apidocs/org/apache/maven/reporting/exec/MavenReportExecutor.html}MavenReportExecutor}}
   ({{{./apidocs/org/apache/maven/reporting/exec/DefaultMavenReportExecutor.html}implementation}}):
   report plugins can be configured in <<<\<configuration\>>>> element of <<<maven-site-plugin>>> or any other