svn commit: r1814820 - in /maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render: AbstractSiteRenderingMojo.java SiteMojo.java

[hboutemy]

Author: hboutemy
Date: Fri Nov 10 06:45:15 2017
New Revision: 1814820

URL: http://svn.apache.org/viewvc?rev=1814820&view=rev
Log:
[MSITE-802] improved explanations of generatedSite parameter

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

Modified: 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java?rev=1814820&r1=1814819&r2=1814820&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
 (original)
+++ 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
 Fri Nov 10 06:45:15 2017
@@ -125,10 +125,14 @@ public abstract class AbstractSiteRender
     private File xdocDirectory;
 
     /**
-     * Directory containing generated documentation.
-     * This is used to pick up other source docs that might have been 
generated at build time.
+     * Directory containing generated documentation in source format (Doxia 
supported markup).
+     * This is used to pick up other source docs that might have been 
generated at build time (by reports or any other
+     * build time mean).
+     * This directory is expected to have the same structure as 
<code>siteDirectory</code>
+     * (ie. one directory per Doxia-source-supported markup types).
      *
-     * @todo should we deprecate in favour of reports?
+     * @todo should we deprecate in favour of reports directly using Doxia 
Sink API, without this Doxia source
+     * intermediate step?
      */
     @Parameter( alias = "workingDirectory", defaultValue = 
"${project.build.directory}/generated-site" )
     protected File generatedSiteDirectory;

Modified: 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java?rev=1814820&r1=1814819&r2=1814820&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
 (original)
+++ 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
 Fri Nov 10 06:45:15 2017
@@ -59,7 +59,7 @@ public class SiteMojo
     extends AbstractSiteRenderingMojo
 {
     /**
-     * Directory where the project sites and report distributions will be 
generated.
+     * Directory where the project sites and report distributions will be 
generated (as html/css/...).
      */
     @Parameter( property = "siteOutputDirectory", defaultValue = 
"${project.reporting.outputDirectory}" )
     protected File outputDirectory;