Author: hboutemy
Date: Thu Sep 1 20:21:57 2011
New Revision: 1164252
URL: http://svn.apache.org/viewvc?rev=1164252&view=rev
Log:
improved javadoc
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=1164252&r1=1164251&r2=1164252&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
Thu Sep 1 20:21:57 2011
@@ -42,13 +42,18 @@ import java.util.Locale;
/**
* 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>:
+ * <ul>
+ * <li>Mojo's execute() method (see maven-plugin-api)</li>
+ * <li>MavenMultiPageReport's generate( Sink, SinkFactory, Locale ) (see
maven-reporting-api)</li>
+ * </ul>
*
* @author <a href="eveni...@apache.org">Emmanuel Venisse</a>
* @version $Id$
* @since 2.0
- * @see #execute()
- * @see #generate(Sink, SinkFactory, Locale)
- * @see #executeReport(Locale)
+ * @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 )
*/
public abstract class AbstractMavenReport
extends AbstractMojo
