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 2010/05/08 15:06:14 UTC
svn commit: r942378 - in
/maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting:
MavenMultiPageReport.java MavenReport.java MavenReportException.java
Author: hboutemy
Date: Sat May 8 13:06:13 2010
New Revision: 942378
URL: http://svn.apache.org/viewvc?rev=942378&view=rev
Log:
improved javadoc
Modified:
maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java
maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java
maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java
Modified: maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java?rev=942378&r1=942377&r2=942378&view=diff
==============================================================================
--- maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java (original)
+++ maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenMultiPageReport.java Sat May 8 13:06:13 2010
@@ -25,12 +25,12 @@ import org.apache.maven.doxia.sink.SinkF
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:kenney@apache.org">Kenney Westerhof</a>
+ * @see MavenReport#generate(org.codehaus.doxia.sink.Sink, Locale)
*/
public interface MavenMultiPageReport
extends MavenReport
Modified: maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java?rev=942378&r1=942377&r2=942378&view=diff
==============================================================================
--- maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java (original)
+++ maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReport.java Sat May 8 13:06:13 2010
@@ -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();
}
Modified: maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java?rev=942378&r1=942377&r2=942378&view=diff
==============================================================================
--- maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java (original)
+++ maven/shared/trunk/maven-reporting-api/src/main/java/org/apache/maven/reporting/MavenReportException.java Sat May 8 13:06:13 2010
@@ -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 extend
* 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 );
}
}