svn commit: r1079698 - in /maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site: AbstractDeployMojo.java SiteDeployMojo.java SiteMap.java

[lt...@apache.org]

Author: ltheussl
Date: Wed Mar  9 08:35:01 2011
New Revision: 1079698

URL: http://svn.apache.org/viewvc?rev=1079698&view=rev
Log:
checkstyle cleanup

Modified:
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java?rev=1079698&r1=1079697&r2=1079698&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractDeployMojo.java Wed Mar  9 08:35:01 2011
@@ -136,6 +136,7 @@ public abstract class AbstractDeployMojo
      * @return the id to look up credentials for the deploy. Not null.
      *
      * @throws MojoExecutionException
+     *      if the ID cannot be determined
      */
     protected abstract String getDeployRepositoryID()
         throws MojoExecutionException;
@@ -147,6 +148,7 @@ public abstract class AbstractDeployMojo
      * @return the url to deploy to. Not null.
      *
      * @throws MojoExecutionException
+     *      if the URL cannot be constructed
      */
     protected abstract String getDeployRepositoryURL()
         throws MojoExecutionException;
@@ -155,6 +157,8 @@ public abstract class AbstractDeployMojo
      * Find the relative path between the distribution URLs of the top parent and the current project.
      *
      * @return a String starting with "/".
+     *
+     * @throws MojoExecutionException
      */
     private String getDeployModuleDirectory()
         throws MojoExecutionException
@@ -194,7 +198,7 @@ public abstract class AbstractDeployMojo
         deploy( inputDirectory, repository );
     }
 
-    private void deploy( final File inputDirectory, final Repository repository )
+    private void deploy( final File directory, final Repository repository )
         throws MojoExecutionException
     {
         // TODO: work on moving this into the deployer like the other deploy methods
@@ -211,7 +215,7 @@ public abstract class AbstractDeployMojo
 
         try
         {
-            push( inputDirectory, repository, wagonManager, wagon,
+            push( directory, repository, wagonManager, wagon,
                 siteTool.getAvailableLocales( locales ), getDeployModuleDirectory() );
 
             if ( chmod )
@@ -501,6 +505,7 @@ public abstract class AbstractDeployMojo
         }
     }
 
+    /** {@inheritDoc} */
     public void contextualize( Context context )
         throws ContextException
     {

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java?rev=1079698&r1=1079697&r2=1079698&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteDeployMojo.java Wed Mar  9 08:35:01 2011
@@ -21,7 +21,6 @@ package org.apache.maven.plugins.site;
 
 import org.apache.maven.model.Site;
 import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.project.MavenProject;
 
 /**
  * Deploys the generated site using <code>scp</code> or <code>file</code>

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java?rev=1079698&r1=1079697&r2=1079698&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/SiteMap.java Wed Mar  9 08:35:01 2011
@@ -47,6 +47,12 @@ public class SiteMap
     private String encoding;
     private I18N i18n;
 
+    /**
+     * Constructor sets default values.
+     *
+     * @param encoding the default encoding to use when writing the output file.
+     * @param i18n the default I18N for translations.
+     */
     public SiteMap( String encoding, I18N i18n )
     {
         this.encoding = encoding;