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/05/29 19:06:09 UTC

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

Author: hboutemy
Date: Thu May 29 17:06:09 2014
New Revision: 1598335

URL: http://svn.apache.org/r1598335
Log:
added comments + javadoc

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

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java?rev=1598335&r1=1598334&r2=1598335&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java Thu May 29 17:06:09 2014
@@ -444,6 +444,13 @@ public abstract class AbstractSiteRender
         return categories;
     }
 
+    /**
+     * Locate every document to be rendered for given locale:<ul>
+     * <li>handwritten content,</li>
+     * <li>reports,</li>
+     * <li>"Project Information" and "Project Reports" category summaries.</li>
+     * </ul>
+     */
     protected Map<String, DocumentRenderer> locateDocuments( SiteRenderingContext context, List<MavenReportExecution> reports,
                                                              Locale locale )
         throws IOException, RendererException
@@ -460,6 +467,7 @@ public abstract class AbstractSiteRender
 
         if ( categories.containsKey( MavenReport.CATEGORY_PROJECT_INFORMATION ) && generateProjectInfo )
         {
+            // add "Project Information" category summary document
             List<MavenReport> categoryReports = categories.get( MavenReport.CATEGORY_PROJECT_INFORMATION );
 
             RenderingContext renderingContext = new RenderingContext( siteDirectory, "project-info.html" );
@@ -481,6 +489,7 @@ public abstract class AbstractSiteRender
 
         if ( categories.containsKey( MavenReport.CATEGORY_PROJECT_REPORTS ) )
         {
+            // add "Project Reports" category summary document
             List<MavenReport> categoryReports = categories.get( MavenReport.CATEGORY_PROJECT_REPORTS );
             RenderingContext renderingContext = new RenderingContext( siteDirectory, "project-reports.html" );
             String title = i18n.getString( "site-plugin", locale, "report.project.title" );