This is an automated email from the ASF dual-hosted git repository. hboutemy pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-reporting-api.git
commit 6d9752c8960007c9115181a522eea1a6034c62de Author: Herve Boutemy <[email protected]> AuthorDate: Sat May 8 13:06:13 2010 +0000 improved javadoc git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@942378 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/maven/reporting/MavenMultiPageReport.java | 8 ++++---- .../java/org/apache/maven/reporting/MavenReport.java | 16 ++++++++++------ .../org/apache/maven/reporting/MavenReportException.java | 9 +++++---- 3 files changed, 19 insertions(+), 14 deletions(-) diff --git a/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java b/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java index f746d39..0f8da37 100644 --- a/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java +++ b/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java @@ -25,12 +25,12 @@ import org.apache.maven.doxia.sink.SinkFactory; import java.util.Locale; /** - * Temporary class for backwards compatibility. This method - * should be moved to the MavenReport class, and the other 'generate' - * method should be dropped. But that will render all reporting mojo's - * uncompilable. + * Interface created separately for backwards compatibility. This method + * would ideally have been added in the {@link MavenReport} interface, and the other 'generate' + * method dropped. But that would have rendered all reporting mojo's uncompilable and binary incompatible. * * @author <a href="mailto:[email protected]";>Kenney Westerhof</a> + * @see MavenReport#generate(org.codehaus.doxia.sink.Sink, Locale) */ public interface MavenMultiPageReport extends MavenReport diff --git a/src/main/java/org/apache/maven/reporting/MavenReport.java b/src/main/java/org/apache/maven/reporting/MavenReport.java index 927c00c..6fa9d75 100644 --- a/src/main/java/org/apache/maven/reporting/MavenReport.java +++ b/src/main/java/org/apache/maven/reporting/MavenReport.java @@ -57,6 +57,8 @@ public interface MavenReport throws MavenReportException; /** + * Get the base name used to create report's output file(s). + * * @return the output name of this report. */ String getOutputName(); @@ -64,20 +66,22 @@ public interface MavenReport /** * Get the category name for this report. * - * @return the category name of this report. Should be <code>CATEGORY_PROJECT_INFORMATION</code> - * or <code>CATEGORY_PROJECT_REPORTS</code> - * {@link #CATEGORY_PROJECT_INFORMATION} - * {@link #CATEGORY_PROJECT_REPORTS} + * @return the category name of this report. Should be {@link #CATEGORY_PROJECT_INFORMATION} + * or {@link #CATEGORY_PROJECT_REPORTS} */ String getCategoryName(); /** + * Get the localized report name. + * * @param locale the wanted locale to return the report's name, could be null. * @return the name of this report. */ String getName( Locale locale ); /** + * Get the localized report description. + * * @param locale the wanted locale to return the report's description, could be null. * @return the description of this report. */ @@ -100,7 +104,7 @@ public interface MavenReport * A good example is javadoc tool. * * @return <tt>true</tt> if this report is external, <tt>false</tt> otherwise. - * Default should <tt>false</tt>. + * Default should be <tt>false</tt>. */ boolean isExternalReport(); @@ -108,7 +112,7 @@ public interface MavenReport * Verify some conditions before generate the report. * * @return <tt>true</tt> if this report could be generated, <tt>false</tt> otherwise. - * Default should <tt>true</tt>. + * Default should be <tt>true</tt>. */ boolean canGenerateReport(); } diff --git a/src/main/java/org/apache/maven/reporting/MavenReportException.java b/src/main/java/org/apache/maven/reporting/MavenReportException.java index 00b08a9..48096fe 100644 --- a/src/main/java/org/apache/maven/reporting/MavenReportException.java +++ b/src/main/java/org/apache/maven/reporting/MavenReportException.java @@ -27,7 +27,8 @@ package org.apache.maven.reporting; * @version $Id$ * @since 2.0 */ -public class MavenReportException extends Exception +public class MavenReportException + extends Exception { /** The serialVersionUID **/ public static final long serialVersionUID = -6200353563231163785L; @@ -46,10 +47,10 @@ public class MavenReportException extends Exception * Other constructor. * * @param msg the exception message. - * @param e the exception. + * @param cause the cause. */ - public MavenReportException( String msg, Exception e ) + public MavenReportException( String msg, Exception cause ) { - super( msg, e ); + super( msg, cause ); } } -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
