You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2014/09/14 01:00:02 UTC

svn commit: r1624789 - in /maven/shared/trunk/maven-reporting-impl/src: main/java/org/apache/maven/reporting/AbstractMavenReport.java site/apt/index.apt.vm

Author: hboutemy
Date: Sat Sep 13 23:00:01 2014
New Revision: 1624789

URL: http://svn.apache.org/r1624789
Log:
improved doc

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

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=1624789&r1=1624788&r2=1624789&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 Sat Sep 13 23:00:01 2014
@@ -43,19 +43,20 @@ import java.util.Map;
 
 /**
  * The basis for a Maven report which can be generated both as part of a site generation or
- * as a direct standalone invocation.
- * Both invocations are delegated to <a href=""><code>abstract executeReport( Locale )</code></a>:
+ * as a direct standalone goal invocation.
+ * Both invocations are delegated to <code>abstract executeReport( Locale )</code> from:
  * <ul> 
- * <li>Mojo's execute() method (see maven-plugin-api)</li>
- * <li>MavenMultiPageReport's generate( Sink, SinkFactory, Locale ) (see maven-reporting-api)</li>
+ * <li>Mojo's <code>execute()</code> method, see maven-plugin-api</li>
+ * <li>MavenMultiPageReport's <code>generate( Sink, SinkFactory, Locale )</code>, see maven-reporting-api</li>
  * </ul>
  *
  * @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
  * @version $Id$
  * @since 2.0
- * @see #execute() Mojo.execute() (from maven-plugin-api) 
- * @see #generate(Sink, SinkFactory, Locale) MavenMultiPageReport.generate( Sink, SinkFactory, Locale ) (from maven-reporting-api)
- * @see #executeReport(Locale) abstract executeReport( Locale )
+ * @see #execute() <code>Mojo.execute()</code>, from maven-plugin-api 
+ * @see #generate(Sink, SinkFactory, Locale) <code>MavenMultiPageReport.generate( Sink, SinkFactory, Locale )</code>,
+ *  from maven-reporting-api
+ * @see #executeReport(Locale) <code>abstract executeReport( Locale )</code>
  */
 public abstract class AbstractMavenReport
     extends AbstractMojo
@@ -313,7 +314,7 @@ public abstract class AbstractMavenRepor
     /**
      * Execute the generation of the report.
      *
-     * @param locale the wanted locale to return the report's description, could be null.
+     * @param locale the wanted locale to return the report's description, could be <code>null</code>.
      * @throws MavenReportException if any
      */
     protected abstract void executeReport( Locale locale )

Modified: maven/shared/trunk/maven-reporting-impl/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-impl/src/site/apt/index.apt.vm?rev=1624789&r1=1624788&r2=1624789&view=diff
==============================================================================
--- maven/shared/trunk/maven-reporting-impl/src/site/apt/index.apt.vm (original)
+++ maven/shared/trunk/maven-reporting-impl/src/site/apt/index.apt.vm Sat Sep 13 23:00:01 2014
@@ -30,11 +30,11 @@ ${project.name}
 
   Abstract classes to manage report generation, which can be run both:
   
-  * as part of a site generation (as a {{{../maven-reporting-api/}maven-reporting-api}}'s
-  <<<{{{../maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html}MavenReport}}>>>),
+  * as part of a site generation, as a {{{../maven-reporting-api/}maven-reporting-api}}'s
+  <<<{{{../maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html}MavenReport}}>>>,
 
-  * or as a direct standalone invocation (as a {{{/ref/current/maven-plugin-api/}maven-plugin-api}}'s
-  <<<{{{/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html}Mojo}})>>>.
+  * or as a direct standalone goal invocation, as a {{{/ref/current/maven-plugin-api/}maven-plugin-api}}'s
+  <<<{{{/ref/current/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html}Mojo}}>>>.
 
   []