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

[hboutemy]

Author: hboutemy
Date: Fri Dec 11 15:40:10 2015
New Revision: 1719461

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

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

Modified: 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java?rev=1719461&r1=1719460&r2=1719461&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java
 (original)
+++ 
maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteMojo.java
 Fri Dec 11 15:40:10 2015
@@ -45,8 +45,8 @@ public abstract class AbstractSiteMojo
     extends AbstractMojo
 {
     /**
-     * A comma separated list of locales supported by Maven. The first valid 
token will be the default Locale
-     * for this instance of the Java Virtual Machine.
+     * A comma separated list of locales to render. The first valid token will 
be the default Locale
+     * for this site.
      *
      * @since 2.3
      */
@@ -66,7 +66,8 @@ public abstract class AbstractSiteMojo
     protected I18N i18n;
 
     /**
-     * Directory containing the site.xml file and the source for apt, fml and 
xdoc docs.
+     * Directory containing the <code>site.xml</code> file and the source for 
hand written docs (one directory
+     * per Doxia-supported markup sources: see <a 
href="/doxia/references/index.html">Doxia Markup Languages References</a>).
      *
      * @since 2.3
      */
@@ -74,7 +75,7 @@ public abstract class AbstractSiteMojo
     protected File siteDirectory;
 
     /**
-     * The maven project.
+     * The Maven project.
      */
     @Parameter( defaultValue = "${project}", readonly = true )
     protected MavenProject project;