(doc) javadoc:fix (auto)

Author: slachiewicz

maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java

@@ -20,20 +20,28 @@
  */
 
 /**
- * Exception occuring during release execution.
+ * Exception occurring during release execution.
  *
  * @author <a href="mailto:[email protected]">Brett Porter</a>
  */
 public class ReleaseExecutionException
     extends Exception
 {
+    /**
+     * Creates a new instance of <code>ReleaseExecutionException</code> without detail message.
+     */
     public ReleaseExecutionException( String message )
     {
         super( message );
     }
 
-    public ReleaseExecutionException( String message, Throwable t )
+    /**
+     * Constructs an instance of <code>ReleaseExecutionException</code> with the specified detail message.
+     *
+     * @param message the detail message.
+     */
+    public ReleaseExecutionException( String message, Throwable cause )
     {
-        super( message, t );
+        super( message, cause );
     }
 }

maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java

@@ -27,7 +27,12 @@
  */
 public class ReleaseResult
 {
-    public static final int UNDEFINED = -1, SUCCESS = 0, ERROR = 1;
+    /** The result of the release. */
+    public static final int UNDEFINED = -1;
+    /** The release was successful. */
+    public static final int SUCCESS = 0;
+    /** The release failed. */
+    public static final int ERROR = 1;
 
     private StringBuilder stdOut = new StringBuilder();
 
@@ -39,47 +44,84 @@ public class ReleaseResult
 
     private static final String LS = System.getProperty( "line.separator" );
 
+    /**
+     * Append Info message to the output.
+     * @param message the message to append
+     */
     public void appendInfo( String message )
     {
         stdOut.append( "[INFO] " ).append( message ).append( LS );
     }
-
+    /**
+     * Append warning message to the output.
+     * @param message the message to append
+     */
     public void appendWarn( String message )
     {
         stdOut.append( "[WARN] " ).append( message ).append( LS );
     }
 
+    /**
+     * Append debug message to the output.
+     * @param message the message to append
+     */
     public void appendDebug( String message )
     {
         stdOut.append( "[DEBUG] " ).append( message ).append( LS );
     }
 
+    /**
+     * Append error message to the output.
+     * @param message the message to append
+     * @param e the exception to append
+     */
     public void appendDebug( String message, Exception e )
     {
         appendDebug( message );
 
         stdOut.append( getStackTrace( e ) ).append( LS );
     }
 
+    /**
+     * Append error message to the output.
+     *
+     * @param message the message to append
+     */
     public void appendError( String message )
     {
         stdOut.append( "[ERROR] " ).append( message ).append( LS );
 
         setResultCode( ERROR );
     }
 
+    /**
+     * Append error exception to the output
+     *
+     * @param e the exception to append
+     */
     public void appendError( Exception e )
     {
         appendError( getStackTrace( e ) );
     }
 
+    /**
+     * Append stack trace to the output
+     *
+     * @param message the message to append
+     * @param e the exception to append
+     */
     public void appendError( String message, Exception e )
     {
         appendError( message );
 
         stdOut.append( getStackTrace( e ) ).append( LS );
     }
 
+    /**
+     * Append message to the output.
+     *
+     * @param message the message to append
+     */
     public void appendOutput( String message )
     {
         stdOut.append( message );

maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java

@@ -24,6 +24,7 @@
 import org.apache.maven.model.Scm;
 
 /**
+ * <p>ReleaseDescriptor interface.</p>
  *
  * @author Robert Scholte
  */
@@ -119,6 +120,7 @@ public interface ReleaseDescriptor
 
     /**
      * Get if the scm provider should sign the tag. NOTE: currently only implemented with git-exe.
+     *
      * @return boolean true if SCM tag should be signed
      */
     boolean isScmSignTags();
@@ -227,6 +229,7 @@ public interface ReleaseDescriptor
     boolean isScmUseEditMode();
 
     /**
+     * <p>getActivateProfiles.</p>
      *
      * @return list of profiles to activate
      */
@@ -422,57 +425,129 @@ public interface ReleaseDescriptor
     String getReleaseStrategyId();
 
     /**
-     * @return {@code String} The original version for the resolved snapshot dependency.
+     * <p>getDependencyOriginalVersion.</p>
      *
+     * @return {@code String} The original version for the resolved snapshot dependency.
      * @param artifactKey the artifact key {@code String}
      */
     String getDependencyOriginalVersion( String artifactKey );
 
     /**
-     * @return {@code String} the release version for the resolved snapshot dependency.
+     * <p>getDependencyReleaseVersion.</p>
      *
+     * @return {@code String} the release version for the resolved snapshot dependency.
      * @param artifactKey the artifact key {@code String}
      */
     String getDependencyReleaseVersion( String artifactKey );
 
     /**
-     * @return {@code String} the release version for the resolved snapshot dependency.
+     * <p>getDependencyDevelopmentVersion.</p>
      *
+     * @return {@code String} the release version for the resolved snapshot dependency.
      * @param artifactKey the artifact key {@code String}
      */
     String getDependencyDevelopmentVersion( String artifactKey );
 
 
+    /**
+     * <p>getProjectOriginalVersion.</p>
+     *
+     * @param projectKey a {@link java.lang.String} object
+     * @return a {@link java.lang.String} object
+     */
     String getProjectOriginalVersion( String projectKey );
 
+    /**
+     * <p>getProjectDevelopmentVersion.</p>
+     *
+     * @param projectKey a {@link java.lang.String} object
+     * @return a {@link java.lang.String} object
+     */
     String getProjectDevelopmentVersion( String projectKey );
 
+    /**
+     * <p>getProjectReleaseVersion.</p>
+     *
+     * @param key a {@link java.lang.String} object
+     * @return a {@link java.lang.String} object
+     */
     String getProjectReleaseVersion( String key );
 
     /**
-     * @return the original {@code Scm} information.
+     * <p>getOriginalScmInfo.</p>
      *
+     * @return the original {@code Scm} information.
      * @param projectKey the project key {@code String}
      */
     Scm getOriginalScmInfo( String projectKey );
 
     // Modifiable
+    /**
+     * <p>addDependencyOriginalVersion.</p>
+     *
+     * @param versionlessKey a {@link java.lang.String} object
+     * @param string a {@link java.lang.String} object
+     */
     void addDependencyOriginalVersion( String versionlessKey, String string );
 
+    /**
+     * <p>addDependencyReleaseVersion.</p>
+     *
+     * @param versionlessKey a {@link java.lang.String} object
+     * @param version a {@link java.lang.String} object
+     */
     void addDependencyReleaseVersion( String versionlessKey, String version );
 
+    /**
+     * <p>addDependencyDevelopmentVersion.</p>
+     *
+     * @param versionlessKey a {@link java.lang.String} object
+     * @param version a {@link java.lang.String} object
+     */
     void addDependencyDevelopmentVersion( String versionlessKey, String version );
 
+    /**
+     * <p>addReleaseVersion.</p>
+     *
+     * @param projectId a {@link java.lang.String} object
+     * @param nextVersion a {@link java.lang.String} object
+     */
     void addReleaseVersion( String projectId, String nextVersion );
 
+    /**
+     * <p>addDevelopmentVersion.</p>
+     *
+     * @param projectId a {@link java.lang.String} object
+     * @param nextVersion a {@link java.lang.String} object
+     */
     void addDevelopmentVersion( String projectId, String nextVersion );
 
+    /**
+     * <p>setScmReleaseLabel.</p>
+     *
+     * @param tag a {@link java.lang.String} object
+     */
     void setScmReleaseLabel( String tag );
 
+    /**
+     * <p>setScmReleasedPomRevision.</p>
+     *
+     * @param scmRevision a {@link java.lang.String} object
+     */
     void setScmReleasedPomRevision( String scmRevision );
 
+    /**
+     * <p>setScmRelativePathProjectDirectory.</p>
+     *
+     * @param scmRelativePathProjectDirectory a {@link java.lang.String} object
+     */
     void setScmRelativePathProjectDirectory( String scmRelativePathProjectDirectory );
 
+    /**
+     * <p>setScmSourceUrl.</p>
+     *
+     * @param scmUrl a {@link java.lang.String} object
+     */
     void setScmSourceUrl( String scmUrl );
 
     /**

maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java

@@ -25,24 +25,52 @@
 import org.apache.maven.settings.Settings;
 
 /**
+ * <p>ReleaseEnvironment interface.</p>
  *
  */
 public interface ReleaseEnvironment
 {
 
+    /** Constant <code>DEFAULT_MAVEN_EXECUTOR_ID="forked-path"</code> */
     String DEFAULT_MAVEN_EXECUTOR_ID = "forked-path";
 
+    /**
+     * <p>getMavenExecutorId.</p>
+     *
+     * @return a {@link java.lang.String} object
+     */
     String getMavenExecutorId();
 
+    /**
+     * <p>getLocalRepositoryDirectory.</p>
+     *
+     * @return a {@link java.io.File} object
+     */
     File getLocalRepositoryDirectory();
 
+    /**
+     * <p>getSettings.</p>
+     *
+     * @return a {@link org.apache.maven.settings.Settings} object
+     */
     Settings getSettings();
 
+    /**
+     * <p>getMavenHome.</p>
+     *
+     * @return a {@link java.io.File} object
+     */
     File getMavenHome();
 
+    /**
+     * <p>getJavaHome.</p>
+     *
+     * @return a {@link java.io.File} object
+     */
     File getJavaHome();
 
     /**
+     * <p>getLocale.</p>
      *
      * @return the locale
      * @since 2.4