svn commit: r610168 - in /maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release: AbstractReleaseMojo.java PerformReleaseMojo.java PrepareReleaseMojo.java RollbackReleaseMojo.java

[de...@apache.org]

Author: dennisl
Date: Tue Jan  8 13:30:05 2008
New Revision: 610168

URL: http://svn.apache.org/viewvc?rev=610168&view=rev
Log:
o Improve javadoc.

Modified:
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
    maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java?rev=610168&r1=610167&r2=610168&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java Tue Jan  8 13:30:05 2008
@@ -114,7 +114,7 @@
     private String pomFileName;
 
     /**
-     * The message prefix to all scm changes
+     * The message prefix to use for all SCM changes.
      *
      * @parameter expression="${scmCommentPrefix}" default-value="[maven-release-plugin] "
      */

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java?rev=610168&r1=610167&r2=610168&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java Tue Jan  8 13:30:05 2008
@@ -28,7 +28,7 @@
 import java.io.File;
 
 /**
- * Perform a release from SCM
+ * Perform a release from SCM.
  *
  * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
@@ -41,7 +41,11 @@
     extends AbstractReleaseMojo
 {
     /**
-     * Comma or space separated goals to execute on deployment.
+     * A comma or space separated list of goals to execute on deployment.
+     *
+     * Default value is either <code>deploy</code> or
+     * <code>deploy site-deploy</code>, if the project has a
+     * &lt;distributionManagement&gt;/&lt;site&gt; element.
      *
      * @parameter expression="${goals}"
      */
@@ -56,7 +60,8 @@
     private File workingDirectory;
 
     /**
-     * The SCM URL to checkout from. If omitted, the one from the release.properties file is used, followed by the URL
+     * The SCM URL to checkout from. If omitted, the one from the
+     * <code>release.properties</code> file is used, followed by the URL
      * from the current POM.
      *
      * @parameter expression="${connectionUrl}"
@@ -64,7 +69,8 @@
     private String connectionUrl;
 
     /**
-     * Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate.
+     * Whether to use the release profile that adds sources and javadocs to the
+     * released artifact, if appropriate.
      *
      * @parameter expression="${useReleaseProfile}" default-value="true"
      */

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java?rev=610168&r1=610167&r2=610168&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java Tue Jan  8 13:30:05 2008
@@ -43,7 +43,7 @@
 {
 
     /**
-     * Resume a previous release attempt from the point that it was stopped.
+     * Resume a previous release attempt from the point where it was stopped.
      *
      * @parameter expression="${resume}" default-value="true"
      */
@@ -72,7 +72,7 @@
 
     /**
      * Whether to automatically assign submodules the parent version.  If set to false,
-     * the user will be prompted for the version of each submodules. 
+     * the user will be prompted for the version of each submodules.
      *
      * @parameter expression="${autoVersionSubmodules}" default-value="false"
      */
@@ -111,12 +111,12 @@
     private boolean commitByProject;
 
     /**
-     * Whether to timestamped SNAPSHOT dependencies.  Default is to fail when finding any SNAPSHOT.
+     * Whether to allow timestamped SNAPSHOT dependencies.  Default is to fail when finding any SNAPSHOT.
      *
      * @parameter expression="${ignoreSnapshots}" default-value="false"
      */
     private boolean allowTimestampedSnapshots;
-    
+
     public void execute()
         throws MojoExecutionException, MojoFailureException
     {

Modified: maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java?rev=610168&r1=610167&r2=610168&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java (original)
+++ maven/release/trunk/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java Tue Jan  8 13:30:05 2008
@@ -26,7 +26,7 @@
 import org.apache.maven.shared.release.ReleaseFailureException;
 
 /**
- * Rollback changes made by a previous release
+ * Rollback changes made by a previous release.
  *
  * @aggregator
  * @goal rollback