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 2011/02/12 17:05:54 UTC

svn commit: r1070100 - /maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/ReportDocumentRenderer.java

Author: hboutemy
Date: Sat Feb 12 16:05:53 2011
New Revision: 1070100

URL: http://svn.apache.org/viewvc?rev=1070100&view=rev
Log:
improved javadoc

Modified:
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/ReportDocumentRenderer.java

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/ReportDocumentRenderer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/ReportDocumentRenderer.java?rev=1070100&r1=1070099&r2=1070100&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/ReportDocumentRenderer.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/ReportDocumentRenderer.java Sat Feb 12 16:05:53 2011
@@ -154,8 +154,10 @@ public class ReportDocumentRenderer
 
         try
         {
+            // try extended multi-page API
             if ( !generateMultiPage( locale, sf, sink ) )
             {
+                // fallback to old single-page-only API
                 try
                 {
                     report.generate( sink, locale );
@@ -213,6 +215,11 @@ public class ReportDocumentRenderer
         }
     }
 
+    /**
+     * Try to generate report with extended multi-page API.
+     * 
+     * @return <code>true</code> if the report was compatible with the extended API
+     */
     private boolean generateMultiPage( Locale locale, SinkFactory sf, Sink sink )
         throws MavenReportException
     {