svn commit: r1334755 - in /maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish: AbstractScmPublishMojo.java ScmPublishPublishMojo.java ScmPublishPublishScmMojo.java

[hb...@apache.org]

Author: hboutemy
Date: Sun May  6 20:20:26 2012
New Revision: 1334755

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

Modified:
    maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java
    maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishMojo.java
    maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishScmMojo.java

Modified: maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java?rev=1334755&r1=1334754&r2=1334755&view=diff
==============================================================================
--- maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java (original)
+++ maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.java Sun May  6 20:20:26 2012
@@ -41,7 +41,7 @@ import org.apache.maven.shared.release.c
 import org.apache.maven.shared.release.scm.ScmRepositoryConfigurator;
 
 /**
- * Base class for the site-scm-publish mojos.
+ * Base class for the scm-publish mojos.
  */
 public abstract class AbstractScmPublishMojo
     extends AbstractMojo

Modified: maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishMojo.java?rev=1334755&r1=1334754&r2=1334755&view=diff
==============================================================================
--- maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishMojo.java (original)
+++ maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishMojo.java Sun May  6 20:20:26 2012
@@ -206,6 +206,11 @@ public class ScmPublishPublishMojo
         checkinFiles();
     }
 
+    /**
+     * Check-in content from scm checkout.
+     * 
+     * @throws MojoExecutionException
+     */
     protected void checkinFiles()
         throws MojoExecutionException
     {
@@ -259,6 +264,13 @@ public class ScmPublishPublishMojo
         }
     }
 
+    /**
+     * Add files to scm.
+     * 
+     * @param added files to be added
+     * @throws MojoFailureException
+     * @throws MojoExecutionException
+     */
     protected void addFiles( Collection<File> added )
         throws MojoFailureException, MojoExecutionException
     {

Modified: maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishScmMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishScmMojo.java?rev=1334755&r1=1334754&r2=1334755&view=diff
==============================================================================
--- maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishScmMojo.java (original)
+++ maven/sandbox/trunk/plugins/maven-scm-publish-plugin/src/main/java/org/apache/maven/plugins/scmpublish/ScmPublishPublishScmMojo.java Sun May  6 20:20:26 2012
@@ -40,7 +40,8 @@ import org.apache.maven.plugin.MojoFailu
  */
 
 /**
- * Publish a content to scm in one step. By default, site staging content is published.
+ * Publish a content to scm in one step. By default, content is taken from default site staging directory
+ * <code>${project.build.directory}/staging</code>.
  * Could be extended to work without project, so usable to update any SCM with any content.
  * 
  * @goal publish-scm
@@ -61,6 +62,13 @@ public class ScmPublishPublishScmMojo
     private List<File> added = new ArrayList<File>();
     private List<File> updated = new ArrayList<File>();
 
+    /**
+     * Update scm checkout directory with content.
+     *
+     * @param checkout the scm checkout directory
+     * @param dir the content to put in scm (can be <code>null</code>)
+     * @throws IOException
+     */
     private void update( File checkout, File dir )
         throws IOException
     {
@@ -112,6 +120,14 @@ public class ScmPublishPublishScmMojo
         }
     }
 
+    /**
+     * Copy a file content, normalizing newlines when necessary.
+     *
+     * @param srcFile the source file
+     * @param destFile the destination file
+     * @throws IOException
+     * @see #requireNormalizeNewlines(File)
+     */
     private void copyFile( File srcFile, File destFile )
         throws IOException
     {
@@ -125,6 +141,13 @@ public class ScmPublishPublishScmMojo
         }
     }
 
+    /**
+     * Copy and normalize newlines.
+     *
+     * @param srcFile the source file
+     * @param destFile the destination file
+     * @throws IOException
+     */
     private void normalizeNewlines( File srcFile, File destFile )
         throws IOException
     {