This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-release.git
The following commit(s) were added to refs/heads/master by this push:
new bfecd2ce Fix Javadoc issues per Oracle conventions (#1408)
bfecd2ce is described below
commit bfecd2ce952ca58913a8e886bd5f5453293b7af6
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Fri Nov 7 12:06:33 2025 +0000
Fix Javadoc issues per Oracle conventions (#1408)
* Fix Javadoc issues per Oracle conventions
* spotless
---
.../shared/release/ReleaseExecutionException.java | 2 +-
.../apache/maven/shared/release/ReleaseResult.java | 8 ++-
.../shared/release/config/ReleaseDescriptor.java | 78 +++++++++++-----------
.../shared/release/env/ReleaseEnvironment.java | 3 +-
.../maven/shared/release/phase/ReleasePhase.java | 4 +-
.../shared/release/policy/naming/NamingPolicy.java | 2 +-
.../release/policy/version/VersionPolicy.java | 4 +-
.../policy/version/VersionPolicyRequest.java | 12 ++--
.../maven/shared/release/strategy/Strategy.java | 12 ++--
.../maven/shared/release/versions/Version.java | 14 ++--
.../shared/release/DefaultReleaseManager.java | 8 +--
.../maven/shared/release/ReleaseManager.java | 8 +--
.../config/PropertiesReleaseDescriptorStore.java | 6 +-
.../release/config/ReleaseDescriptorBuilder.java | 2 +-
.../release/config/ReleaseDescriptorStore.java | 4 +-
.../maven/shared/release/config/ReleaseUtils.java | 2 +-
.../shared/release/exec/ForkedMavenExecutor.java | 2 +-
.../maven/shared/release/exec/RawStreamPumper.java | 4 +-
.../release/phase/AbstractInputVariablesPhase.java | 8 +--
.../release/phase/AbstractMapVersionsPhase.java | 2 +-
.../release/phase/AbstractRewritePomsPhase.java | 12 ++--
.../release/phase/AbstractRunGoalsPhase.java | 6 +-
.../phase/AbstractScmCommitDevelopmentPhase.java | 2 +-
.../release/phase/AbstractScmCommitPhase.java | 16 ++---
.../shared/release/phase/RemoveScmTagPhase.java | 2 +-
.../release/phase/RewritePomVersionsPhase.java | 2 +-
.../phase/RewritePomsForDevelopmentPhase.java | 2 +-
.../maven/shared/release/scm/IdentifiedScm.java | 2 +-
.../release/scm/ScmRepositoryConfigurator.java | 4 +-
.../shared/release/strategies/DefaultStrategy.java | 2 +-
.../maven/shared/release/transform/ModelETL.java | 4 +-
.../shared/release/transform/jdom2/JDomBuild.java | 2 +-
.../release/transform/jdom2/JDomDependency.java | 2 +-
.../transform/jdom2/JDomDependencyManagement.java | 2 +-
.../release/transform/jdom2/JDomExtension.java | 2 +-
.../shared/release/transform/jdom2/JDomModel.java | 5 +-
.../shared/release/transform/jdom2/JDomParent.java | 2 +-
.../shared/release/transform/jdom2/JDomPlugin.java | 2 +-
.../transform/jdom2/JDomPluginManagement.java | 2 +-
.../release/transform/jdom2/JDomProfile.java | 2 +-
.../release/transform/jdom2/JDomReportPlugin.java | 2 +-
.../release/transform/jdom2/JDomReporting.java | 2 +-
.../shared/release/transform/jdom2/JDomScm.java | 2 +-
.../shared/release/transform/jdom2/JDomUtils.java | 6 +-
.../shared/release/util/CiFriendlyVersion.java | 4 +-
.../maven/shared/release/util/MavenExpression.java | 1 +
.../maven/shared/release/util/PomFinder.java | 9 +--
.../maven/shared/release/util/ReleaseUtil.java | 16 ++---
.../release/versions/DefaultVersionInfo.java | 10 +--
.../maven/shared/release/versions/VersionInfo.java | 5 +-
.../maven/plugins/release/AbstractReleaseMojo.java | 26 +++-----
.../release/AbstractScmReadReleaseMojo.java | 10 ++-
.../release/AbstractScmReadWriteReleaseMojo.java | 1 +
.../maven/plugins/release/BranchReleaseMojo.java | 6 +-
.../maven/plugins/release/PerformReleaseMojo.java | 4 +-
.../maven/plugins/release/PrepareReleaseMojo.java | 9 +--
.../maven/plugins/release/RollbackReleaseMojo.java | 2 +-
.../policy/oddeven/OddEvenVersionPolicy.java | 1 -
.../release/policy/semver/SemVerVersionPolicy.java | 3 +-
59 files changed, 190 insertions(+), 189 deletions(-)
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java
index c121f2e5..da037e8a 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java
@@ -34,7 +34,7 @@ public class ReleaseExecutionException extends Exception {
/**
* Constructs an instance of <code>ReleaseExecutionException</code> with
the specified detail message.
*
- * @param message the detail message.
+ * @param message the detail message
*/
public ReleaseExecutionException(String message, Throwable cause) {
super(message, cause);
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java
index 57f3f4c1..6ae5deff 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java
@@ -44,6 +44,7 @@ public class ReleaseResult {
/**
* Append Info message to the output.
+ *
* @param message the message to append
*/
public void appendInfo(String message) {
@@ -51,6 +52,7 @@ public class ReleaseResult {
}
/**
* Append warning message to the output.
+ *
* @param message the message to append
*/
public void appendWarn(String message) {
@@ -59,6 +61,7 @@ public class ReleaseResult {
/**
* Append debug message to the output.
+ *
* @param message the message to append
*/
public void appendDebug(String message) {
@@ -67,6 +70,7 @@ public class ReleaseResult {
/**
* Append error message to the output.
+ *
* @param message the message to append
* @param e the exception to append
*/
@@ -88,7 +92,7 @@ public class ReleaseResult {
}
/**
- * Append error exception to the output
+ * Append error exception to the output.
*
* @param e the exception to append
*/
@@ -97,7 +101,7 @@ public class ReleaseResult {
}
/**
- * Append stack trace to the output
+ * Append stack trace to the output.
*
* @param message the message to append
* @param e the exception to append
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java
index 8d7462b2..dcdd8ab1 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java
@@ -147,42 +147,42 @@ public interface ReleaseDescriptor {
* This field allows you to specify that Work Item
* or Task. It is optional, and only relevant if pushChanges is true.
*
- * @return String
+ * @return string
*/
String getWorkItem();
/**
* Get default version to use for new working copy.
*
- * @return String
+ * @return string
*/
String getDefaultDevelopmentVersion();
/**
* Get relative path of the project returned by the checkout command.
*
- * @return String
+ * @return string
*/
String getScmRelativePathProjectDirectory();
/**
* Get the directory where the tag will be checked out.
*
- * @return String
+ * @return string
*/
String getCheckoutDirectory();
/**
* Get the goals to execute in perform phase for the release.
*
- * @return String
+ * @return string
*/
String getPerformGoals();
/**
* Get default version to use for the tagged release or the new branch.
*
- * @return String
+ * @return string
*/
String getDefaultReleaseVersion();
@@ -190,7 +190,7 @@ public interface ReleaseDescriptor {
* Get nOTE : currently only implemented with svn scm. It contains the
revision of the committed released pom to
* remotely tag the source code with this revision.
*
- * @return String
+ * @return string
*/
String getScmReleasedPomRevision();
@@ -235,49 +235,49 @@ public interface ReleaseDescriptor {
/**
* Get the last completed phase.
*
- * @return String
+ * @return string
*/
String getCompletedPhase();
/**
* Method getCheckModificationExcludes.
*
- * @return List
+ * @return list
*/
List<String> getCheckModificationExcludes();
/**
* Get additional arguments to pass to any executed Maven process.
*
- * @return String
+ * @return string
*/
String getAdditionalArguments();
/**
* Get the goals to execute in preparation for the release.
*
- * @return String
+ * @return string
*/
String getPreparationGoals();
/**
* Get the goals to execute in on completion of preparation for the
release.
*
- * @return String
+ * @return string
*/
String getCompletionGoals();
/**
* Get the file name of the POM to pass to any executed Maven process.
*
- * @return String
+ * @return string
*/
String getPomFileName();
/**
* Get the prefix of SCM modification messages.
*
- * @return String
+ * @return string
*/
String getScmCommentPrefix();
@@ -293,7 +293,7 @@ public interface ReleaseDescriptor {
/**
* Get the SCM commit comment when setting pom.xml to release.
*
- * @return String
+ * @return string
* @since 3.0.0-M1
*/
String getScmReleaseCommitComment();
@@ -301,7 +301,7 @@ public interface ReleaseDescriptor {
/**
* Get the SCM commit comment when setting pom.xml back to development.
*
- * @return String
+ * @return string
* @since 3.0.0-M1
*/
String getScmDevelopmentCommitComment();
@@ -309,7 +309,7 @@ public interface ReleaseDescriptor {
/**
* Get the SCM commit comment when branching.
*
- * @return String
+ * @return string
* @since 3.0.0-M1
*/
String getScmBranchCommitComment();
@@ -317,7 +317,7 @@ public interface ReleaseDescriptor {
/**
* Get the SCM commit comment when rolling back.
*
- * @return String
+ * @return string
* @since 3.0.0-M1
*/
String getScmRollbackCommitComment();
@@ -325,35 +325,35 @@ public interface ReleaseDescriptor {
/**
* Get pass phrase for the private key.
*
- * @return String
+ * @return string
*/
String getScmPrivateKeyPassPhrase();
/**
* Get the password for the user interacting with the scm.
*
- * @return String
+ * @return string
*/
String getScmPassword();
/**
* Get private key for an SSH based SCM repository.
*
- * @return String
+ * @return string
*/
String getScmPrivateKey();
/**
* Get tag or branch name: the identifier for the tag/branch. Example:
maven-release-plugin-2.0.
*
- * @return String
+ * @return string
*/
String getScmReleaseLabel();
/**
* Get where you are going to put your tagged sources Example
https://svn.apache.org/repos/asf/maven/plugins/tags.
*
- * @return String
+ * @return string
*/
String getScmTagBase();
@@ -361,7 +361,7 @@ public interface ReleaseDescriptor {
* Get where you are going to put your branched sources Example
* https://svn.apache.org/repos/asf/maven/plugins/branches.
*
- * @return String
+ * @return string
*/
String getScmBranchBase();
@@ -378,14 +378,14 @@ public interface ReleaseDescriptor {
* Get this is a MavenSCM of where you're going to get the sources to make
the release with. Example:
*
scm:svn:https://svn.apache.org/repos/asf/maven/plugins/trunk/maven-release-plugin.
*
- * @return String
+ * @return string
*/
String getScmSourceUrl();
/**
* Get the user name to interact with the scm.
*
- * @return String
+ * @return string
*/
String getScmUsername();
@@ -399,7 +399,7 @@ public interface ReleaseDescriptor {
/**
* Get the directory where the release is performed.
*
- * @return String
+ * @return string
*/
String getWorkingDirectory();
@@ -407,59 +407,59 @@ public interface ReleaseDescriptor {
* Get specifies the format for generating a tag name. Property expansion
is used with the optional prefix of
* project, where properties are delimited with @{ and }.
*
- * @return String
+ * @return string
*/
String getScmTagNameFormat();
/**
* Get the role-hint for the NamingPolicy implementation used to calculate
the project branch and tag names.
*
- * @return String
+ * @return string
*/
String getProjectNamingPolicyId();
/**
* Get the role-hint for the VersionPolicy implementation used to
calculate the project versions.
*
- * @return String
+ * @return string
*/
String getProjectVersionPolicyId();
/**
* Get the (optional) config for the VersionPolicy implementation used to
calculate the project versions.
*
- * @return The parsed XML of the provided config (an instance of
PlexusConfiguration) or null.
+ * @return the parsed XML of the provided config (an instance of
PlexusConfiguration) or null
*/
Object getProjectVersionPolicyConfig();
/**
* Get the role-hint for the release Strategy implementation.
*
- * @return String
+ * @return string
*/
String getReleaseStrategyId();
/**
* <p>getDependencyOriginalVersion.</p>
*
- * @return {@code String} The original version for the resolved snapshot
dependency.
* @param artifactKey the artifact key {@code String}
+ * @return {@code String} The original version for the resolved snapshot
dependency
*/
String getDependencyOriginalVersion(String artifactKey);
/**
* <p>getDependencyReleaseVersion.</p>
*
- * @return {@code String} the release version for the resolved snapshot
dependency.
* @param artifactKey the artifact key {@code String}
+ * @return {@code String} the release version for the resolved snapshot
dependency
*/
String getDependencyReleaseVersion(String artifactKey);
/**
* <p>getDependencyDevelopmentVersion.</p>
*
- * @return {@code String} the release version for the resolved snapshot
dependency.
* @param artifactKey the artifact key {@code String}
+ * @return {@code String} the release version for the resolved snapshot
dependency
*/
String getDependencyDevelopmentVersion(String artifactKey);
@@ -491,7 +491,7 @@ public interface ReleaseDescriptor {
* <p>getOriginalScmInfo.</p>
*
* @param projectKey the project key {@code String}
- * @return the original {@code Scm} information.
+ * @return the original {@code Scm} information
*/
Scm getOriginalScmInfo(String projectKey);
@@ -499,7 +499,7 @@ public interface ReleaseDescriptor {
* <p>hasOriginalScmInfo.</p>
*
* @param projectKey the project key {@code String}
- * @return has original Scm info.
+ * @return has original Scm info
*/
boolean hasOriginalScmInfo(String projectKey);
@@ -585,14 +585,14 @@ public interface ReleaseDescriptor {
* <li>"extensions" or "4": resolve extension dependencies</li>
* </ul>
*
- * @return String
+ * @return string
*/
String getAutoResolveSnapshots();
/**
* Get the line separator to use in the pom.xml.
*
- * @return String
+ * @return string
*/
String getLineSeparator();
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java
index 6eae54ce..fc09320f 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java
@@ -24,11 +24,10 @@ import org.apache.maven.settings.Settings;
/**
* <p>ReleaseEnvironment interface.</p>
- *
*/
public interface ReleaseEnvironment {
- /** Constant <code>DEFAULT_MAVEN_EXECUTOR_ID="forked-path"</code> */
+ /** Constant <code>DEFAULT_MAVEN_EXECUTOR_ID="forked-path"</code>. */
String DEFAULT_MAVEN_EXECUTOR_ID = "forked-path";
/**
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/ReleasePhase.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/ReleasePhase.java
index 5f9359be..b8a32d44 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/ReleasePhase.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/ReleasePhase.java
@@ -39,9 +39,9 @@ public interface ReleasePhase {
* @param releaseDescriptor the configuration to use
* @param releaseEnvironment the environmental configuration, such as
Maven settings, Maven home, etc.
* @param reactorProjects the reactor projects
+ * @return the release result
* @throws ReleaseExecutionException an exception during the execution of
the phase
* @throws ReleaseFailureException a failure during the execution of the
phase
- * @return the release result
*/
ReleaseResult execute(
ReleaseDescriptor releaseDescriptor,
@@ -55,9 +55,9 @@ public interface ReleasePhase {
* @param releaseDescriptor the configuration to use
* @param releaseEnvironment the environmental configuration, such as
Maven settings, Maven home, etc.
* @param reactorProjects the reactor projects
+ * @return the release result
* @throws ReleaseExecutionException an exception during the execution of
the phase
* @throws ReleaseFailureException a failure during the execution of the
phase
- * @return the release result
*/
ReleaseResult simulate(
ReleaseDescriptor releaseDescriptor,
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
index 22fe295c..43c5e8c3 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
@@ -29,8 +29,8 @@ public interface NamingPolicy {
/**
* <p>getName.</p>
*
- * @return the calculation of the name used for branching or tagging.
* @param request the {@code NamingPolicyRequest}
+ * @return the calculation of the name used for branching or tagging
* @throws org.apache.maven.shared.release.policy.PolicyException if
exception in the policy
*/
NamingPolicyResult getName(NamingPolicyRequest request) throws
PolicyException;
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
index 037b4de1..a17c562d 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
@@ -30,8 +30,8 @@ public interface VersionPolicy {
/**
* <p>getReleaseVersion.</p>
*
- * @return the calculation of the release version from development state.
* @param request the {@code VersionPolicyRequest}
+ * @return the calculation of the release version from development state
* @throws org.apache.maven.shared.release.policy.PolicyException if
exception in the policy
* @throws org.apache.maven.shared.release.versions.VersionParseException
if exception parsing the version
*/
@@ -40,8 +40,8 @@ public interface VersionPolicy {
/**
* <p>getDevelopmentVersion.</p>
*
- * @return the calculation of the next development version from release
state.
* @param request the {@code VersionPolicyRequest}
+ * @return the calculation of the next development version from release
state
* @throws org.apache.maven.shared.release.policy.PolicyException if
exception in the policy
* @throws org.apache.maven.shared.release.versions.VersionParseException
if exception parsing the version
*/
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyRequest.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyRequest.java
index fffdd54f..2bdd0406 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyRequest.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyRequest.java
@@ -91,7 +91,7 @@ public class VersionPolicyRequest {
/**
* <p>Setter for the field <code>scmRepository</code>.</p>
*
- * @param scmRepository The {@link ScmRepository} where the history can be
retrieved.
+ * @param scmRepository the {@link ScmRepository} where the history can be
retrieved
* @return a {@link
org.apache.maven.shared.release.policy.version.VersionPolicyRequest} object
*/
public VersionPolicyRequest setScmRepository(ScmRepository scmRepository) {
@@ -111,7 +111,7 @@ public class VersionPolicyRequest {
/**
* <p>Setter for the field <code>scmProvider</code>.</p>
*
- * @param scmProvider The {@link ScmProvider} where the history can be
retrieved.
+ * @param scmProvider the {@link ScmProvider} where the history can be
retrieved
* @return a {@link
org.apache.maven.shared.release.policy.version.VersionPolicyRequest} object
*/
public VersionPolicyRequest setScmProvider(ScmProvider scmProvider) {
@@ -122,7 +122,7 @@ public class VersionPolicyRequest {
/**
* <p>Getter for the field <code>workingDirectory</code>.</p>
*
- * @return the {@link String} that contains the workingDirectory (can be
null or empty).
+ * @return the {@link String} that contains the workingDirectory (can be
null or empty)
*/
public String getWorkingDirectory() {
return workingDirectory;
@@ -131,7 +131,7 @@ public class VersionPolicyRequest {
/**
* <p>Setter for the field <code>workingDirectory</code>.</p>
*
- * @param workingDirectory The {@link String} that contains the
workingDirectory (can be null or empty).
+ * @param workingDirectory the {@link String} that contains the
workingDirectory (can be null or empty)
* @return a {@link
org.apache.maven.shared.release.policy.version.VersionPolicyRequest} object
*/
public VersionPolicyRequest setWorkingDirectory(String workingDirectory) {
@@ -142,7 +142,7 @@ public class VersionPolicyRequest {
/**
* <p>Getter for the field <code>config</code>.</p>
*
- * @return the {@link String} that contains the config (can be null or
empty).
+ * @return the {@link String} that contains the config (can be null or
empty)
*/
public String getConfig() {
return config;
@@ -151,7 +151,7 @@ public class VersionPolicyRequest {
/**
* <p>Setter for the field <code>config</code>.</p>
*
- * @param config The {@link String} that contains the config (can be null
or empty).
+ * @param config the {@link String} that contains the config (can be null
or empty)
* @return a {@link
org.apache.maven.shared.release.policy.version.VersionPolicyRequest} object
*/
public VersionPolicyRequest setConfig(String config) {
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/strategy/Strategy.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/strategy/Strategy.java
index 64d40d9e..c6cb0295 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/strategy/Strategy.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/strategy/Strategy.java
@@ -23,7 +23,7 @@ import java.util.List;
/**
* Interface to override default strategy.
*
- * If a method returns {@code null}, the default will be used, otherwise the
provided collection of phaseIds
+ * If a method returns {@code null}, the default will be used, otherwise the
provided collection of phaseIds.
*
* @author Robert Scholte
*/
@@ -31,35 +31,35 @@ public interface Strategy {
/**
* <p>getPreparePhases.</p>
*
- * @return The release phases to execute the calling the prepare goal
+ * @return the release phases to execute the calling the prepare goal
*/
List<String> getPreparePhases();
/**
* <p>getPerformPhases.</p>
*
- * @return The release phases to execute the calling the perform goal
+ * @return the release phases to execute the calling the perform goal
*/
List<String> getPerformPhases();
/**
* <p>getBranchPhases.</p>
*
- * @return The release phases to execute the calling the branch goal
+ * @return the release phases to execute the calling the branch goal
*/
List<String> getBranchPhases();
/**
* <p>getRollbackPhases.</p>
*
- * @return The release phases to execute the calling the rollback goal
+ * @return the release phases to execute the calling the rollback goal
*/
List<String> getRollbackPhases();
/**
* <p>getUpdateVersionsPhases.</p>
*
- * @return The release phases to execute the calling the update-versions
goal
+ * @return the release phases to execute the calling the update-versions
goal
*/
List<String> getUpdateVersionsPhases();
}
diff --git
a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/Version.java
b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/Version.java
index b6fdfeb4..423e358a 100644
---
a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/Version.java
+++
b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/Version.java
@@ -73,7 +73,7 @@ public class Version implements Comparable<Version>,
Cloneable {
private static final String DEFAULT_BUILD_SEPARATOR = "-";
- /** Constant <code>STANDARD_PATTERN</code> */
+ /** Constant <code>STANDARD_PATTERN</code>. */
public static final Pattern STANDARD_PATTERN = Pattern.compile(
"^((?:\\d+\\.)*\\d+)" // digit(s) and '.' repeated -
// followed by digit (version
@@ -89,7 +89,7 @@ public class Version implements Comparable<Version>,
Cloneable {
* supports version numbers like: trunk-SNAPSHOT branchName-SNAPSHOT
SNAPSHOT
*/
// for SNAPSHOT releases only (possible versions include: trunk-SNAPSHOT
or SNAPSHOT)
- /** Constant <code>ALTERNATE_PATTERN</code> */
+ /** Constant <code>ALTERNATE_PATTERN</code>. */
public static final Pattern ALTERNATE_PATTERN =
Pattern.compile("^(SNAPSHOT|[a-zA-Z]+[_-]SNAPSHOT)");
private Version(
@@ -118,7 +118,7 @@ public class Version implements Comparable<Version>,
Cloneable {
* <p>Constructor for Version.</p>
*
* @param version a {@link java.lang.String} object
- * @throws org.apache.maven.shared.release.versions.VersionParseException
if any.
+ * @throws org.apache.maven.shared.release.versions.VersionParseException
if any
*/
public Version(String version) throws VersionParseException {
this.strVersion = version;
@@ -221,10 +221,10 @@ public class Version implements Comparable<Version>,
Cloneable {
}
/**
- * Simply joins the items in the list with "." period
+ * Simply joins the items in the list with "." period.
*
- * @return a {@code String} containing the items in the list joined by "."
period
* @param digits the list of digits {@code List<String>}
+ * @return a {@code String} containing the items in the list joined by "."
period
*/
protected static String joinDigitString(List<String> digits) {
return digits != null ? StringUtils.join(digits.iterator(),
DIGIT_SEPARATOR_STRING) : null;
@@ -351,11 +351,11 @@ public class Version implements Comparable<Version>,
Cloneable {
/**
* <p>compareTo.</p>
*
+ * @param other a {@link org.apache.maven.shared.release.versions.Version}
object
+ * @return a int
* @throws
org.apache.maven.shared.release.versions.VersionComparisonConflictException
* if {@link org.eclipse.aether.version.Version} and
* {@link org.apache.maven.artifact.versioning.ArtifactVersion
ArtifactVersion} give different results
- * @param other a {@link org.apache.maven.shared.release.versions.Version}
object
- * @return a int
*/
public int compareTo(Version other) throws
VersionComparisonConflictException {
int aetherComparisonResult =
this.aetherVersion.compareTo(other.aetherVersion);
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManager.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManager.java
index bf793f0c..716d334a 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManager.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManager.java
@@ -452,10 +452,10 @@ public class DefaultReleaseManager implements
ReleaseManager {
* checkout directory. For some SCMs, the project root directory is not the
* checkout directory itself, but a SCM-specific subdirectory.
*
- * @param checkoutDirectory The checkout directory as
java.io.File
- * @param relativePathProjectDirectory The relative path of the project
directory within the checkout
+ * @param checkoutDirectory the checkout directory as
java.io.File
+ * @param relativePathProjectDirectory the relative path of the project
directory within the checkout
* directory or ""
- * @return The working directory
+ * @return the working directory
*/
protected File determineWorkingDirectory(File checkoutDirectory, String
relativePathProjectDirectory) {
if (relativePathProjectDirectory != null &&
!relativePathProjectDirectory.isEmpty()) {
@@ -483,7 +483,7 @@ public class DefaultReleaseManager implements
ReleaseManager {
* <p>clean.</p>
*
* @param releaseRequest a {@link
org.apache.maven.shared.release.AbstractReleaseRequest} object
- * @throws org.apache.maven.shared.release.ReleaseFailureException if any.
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if any
*/
protected void clean(AbstractReleaseRequest releaseRequest) throws
ReleaseFailureException {
ReleaseCleanRequest cleanRequest = new ReleaseCleanRequest();
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManager.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManager.java
index 499528f0..1ee1c426 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManager.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManager.java
@@ -51,7 +51,7 @@ public interface ReleaseManager {
ReleaseResult performWithResult(ReleasePerformRequest performRequest);
/**
- * Perform a release
+ * Perform a release.
*
* @param performRequest all perform arguments
* @throws org.apache.maven.shared.release.ReleaseExecutionException if
there is a problem performing the release
@@ -70,7 +70,7 @@ public interface ReleaseManager {
void clean(ReleaseCleanRequest cleanRequest) throws
ReleaseFailureException;
/**
- * Rollback changes made by the previous release
+ * Rollback changes made by the previous release.
*
* @param rollbackRequest all rollback arguments
* @throws org.apache.maven.shared.release.ReleaseExecutionException if
there is a problem during release rollback
@@ -80,7 +80,7 @@ public interface ReleaseManager {
void rollback(ReleaseRollbackRequest rollbackRequest) throws
ReleaseExecutionException, ReleaseFailureException;
/**
- * Branch a project
+ * Branch a project.
*
* @param branchRequest all branch arguments
* @throws org.apache.maven.shared.release.ReleaseExecutionException if
there is a problem during release branch
@@ -90,7 +90,7 @@ public interface ReleaseManager {
void branch(ReleaseBranchRequest branchRequest) throws
ReleaseExecutionException, ReleaseFailureException;
/**
- * Update version numbers for a project
+ * Update version numbers for a project.
*
* @param updateVersionsRequest all update versions arguments
* @throws org.apache.maven.shared.release.ReleaseExecutionException if
there is a problem during update versions
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/PropertiesReleaseDescriptorStore.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/PropertiesReleaseDescriptorStore.java
index 8faf3844..00fe00b0 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/PropertiesReleaseDescriptorStore.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/PropertiesReleaseDescriptorStore.java
@@ -71,7 +71,7 @@ public class PropertiesReleaseDescriptorStore implements
ReleaseDescriptorStore
*
* @param file a {@link java.io.File} object
* @return a {@link
org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
- * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
+ * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any
*/
public ReleaseDescriptorBuilder read(File file) throws
ReleaseDescriptorStoreException {
return read(null, file);
@@ -83,7 +83,7 @@ public class PropertiesReleaseDescriptorStore implements
ReleaseDescriptorStore
* @param mergeDescriptor a {@link
org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
* @param file a {@link java.io.File} object
* @return a {@link
org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
- * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
+ * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any
*/
public ReleaseDescriptorBuilder read(ReleaseDescriptorBuilder
mergeDescriptor, File file)
throws ReleaseDescriptorStoreException {
@@ -135,7 +135,7 @@ public class PropertiesReleaseDescriptorStore implements
ReleaseDescriptorStore
* @param config a {@link
org.apache.maven.shared.release.config.ReleaseDescriptorBuilder.BuilderReleaseDescriptor}
* object
* @param file a {@link java.io.File} object
- * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
+ * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any
*/
@SuppressWarnings("checkstyle:MethodLength")
public void write(BuilderReleaseDescriptor config, File file) throws
ReleaseDescriptorStoreException {
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
index 6a04f2b7..68ed0728 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
@@ -39,7 +39,7 @@ public class ReleaseDescriptorBuilder {
private final Logger logger;
/**
- * Hides inner logic of the release descriptor
+ * Hides inner logic of the release descriptor.
*
* @author Robert Scholte
*/
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStore.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStore.java
index d82eba3a..e8de4af7 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStore.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStore.java
@@ -30,7 +30,7 @@ public interface ReleaseDescriptorStore {
* @param mergeDescriptor configuration to merge with the loaded
configuration. Some values are used as defaults,
* while others are used to override
* @return the configuration
- * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
+ * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any
*/
ReleaseDescriptorBuilder read(ReleaseDescriptorBuilder mergeDescriptor)
throws ReleaseDescriptorStoreException;
@@ -38,7 +38,7 @@ public interface ReleaseDescriptorStore {
* Save a configuration.
*
* @param config the configuration
- * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
+ * @throws
org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any
*/
void write(ReleaseDescriptor config) throws
ReleaseDescriptorStoreException;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseUtils.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseUtils.java
index 100fd02d..5bd8a469 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseUtils.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseUtils.java
@@ -28,7 +28,7 @@ import
org.apache.maven.shared.release.config.ReleaseDescriptorBuilder.BuilderRe
import org.apache.maven.shared.release.scm.IdentifiedScm;
/**
- * Class providing utility methods used during the release process
+ * Class providing utility methods used during the release process.
*
* @author <a href="mailto:[email protected]";>Jeremy Whitlock</a>
*/
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/ForkedMavenExecutor.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/ForkedMavenExecutor.java
index 83f57b1d..14fa429d 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/ForkedMavenExecutor.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/ForkedMavenExecutor.java
@@ -164,7 +164,7 @@ public class ForkedMavenExecutor extends
AbstractMavenExecutor {
* @param systemOut a {@link java.io.OutputStream} object
* @param systemErr a {@link java.io.OutputStream} object
* @return a int
- * @throws org.codehaus.plexus.util.cli.CommandLineException if any.
+ * @throws org.codehaus.plexus.util.cli.CommandLineException if any
*/
public static int executeCommandLine(
Commandline cl, InputStream systemIn, OutputStream systemOut,
OutputStream systemErr)
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/RawStreamPumper.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/RawStreamPumper.java
index 2988b0b4..45c4c303 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/RawStreamPumper.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/RawStreamPumper.java
@@ -71,7 +71,7 @@ public class RawStreamPumper extends Thread {
/**
* <p>closeInput.</p>
*
- * @throws java.io.IOException if any.
+ * @throws java.io.IOException if any
*/
public void closeInput() throws IOException {
in.close();
@@ -80,7 +80,7 @@ public class RawStreamPumper extends Thread {
/**
* <p>closeOutput.</p>
*
- * @throws java.io.IOException if any.
+ * @throws java.io.IOException if any
*/
public void closeOutput() throws IOException {
out.close();
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractInputVariablesPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractInputVariablesPhase.java
index c248c5cb..eb08acd4 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractInputVariablesPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractInputVariablesPhase.java
@@ -69,7 +69,7 @@ public abstract class AbstractInputVariablesPhase extends
AbstractReleasePhase {
private final ScmRepositoryConfigurator scmRepositoryConfigurator;
/**
- * Component used for custom or default naming policy
+ * Component used for custom or default naming policy.
*/
private final Map<String, NamingPolicy> namingPolicies;
@@ -79,7 +79,7 @@ public abstract class AbstractInputVariablesPhase extends
AbstractReleasePhase {
private final boolean branchOperation;
/**
- * The default naming policy to apply, if any
+ * The default naming policy to apply, if any.
*/
private final String defaultNamingPolicy;
@@ -113,8 +113,8 @@ public abstract class AbstractInputVariablesPhase extends
AbstractReleasePhase {
* @param releaseDescriptor a {@link ReleaseDescriptor} object
* @param releaseEnvironment a {@link ReleaseEnvironment} object
* @return a {@link ScmProvider} object
- * @throws ReleaseScmRepositoryException if any.
- * @throws ReleaseExecutionException if any.
+ * @throws ReleaseExecutionException if any
+ * @throws ReleaseScmRepositoryException if any
*/
protected ScmProvider getScmProvider(ReleaseDescriptor releaseDescriptor,
ReleaseEnvironment releaseEnvironment)
throws ReleaseScmRepositoryException, ReleaseExecutionException {
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractMapVersionsPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractMapVersionsPhase.java
index ff3fcfe4..e5521672 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractMapVersionsPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractMapVersionsPhase.java
@@ -88,7 +88,7 @@ public abstract class AbstractMapVersionsPhase extends
AbstractReleasePhase {
private final Prompter prompter;
/**
- * Component used for custom or default version policy
+ * Component used for custom or default version policy.
*/
private final Map<String, VersionPolicy> versionPolicies;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
index 91b16645..a34df0d8 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
@@ -90,7 +90,7 @@ public abstract class AbstractRewritePomsPhase extends
AbstractReleasePhase impl
private Map<String, ScmTranslator> scmTranslators;
/**
- * Use jdom2-sax as default
+ * Use jdom2-sax as default.
*/
private String modelETL = JDomModelETLFactory.NAME;
@@ -729,7 +729,7 @@ public abstract class AbstractRewritePomsPhase extends
AbstractReleasePhase impl
* @param projectId a {@link java.lang.String} object
* @param scmRepository a {@link
org.apache.maven.scm.repository.ScmRepository} object
* @param result a {@link
org.apache.maven.shared.release.ReleaseResult} object
- * @throws org.apache.maven.shared.release.ReleaseExecutionException if
any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any
*/
protected abstract void transformScm(
MavenProject project,
@@ -766,10 +766,10 @@ public abstract class AbstractRewritePomsPhase extends
AbstractReleasePhase impl
* Determines the relative path from trunk to tag, and adds this relative
path
* to the url.
*
- * @param trunkPath - The trunk url
- * @param tagPath - The tag base
- * @param urlPath - scm.url or scm.connection
- * @return The url path for the tag.
+ * @param trunkPath the trunk url
+ * @param tagPath the tag base
+ * @param urlPath scm.url or scm.connection
+ * @return the url path for the tag
*/
protected static String translateUrlPath(String trunkPath, String tagPath,
String urlPath) {
trunkPath = trunkPath.trim();
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRunGoalsPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRunGoalsPhase.java
index 76794f45..0aca7610 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRunGoalsPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRunGoalsPhase.java
@@ -143,10 +143,10 @@ public abstract class AbstractRunGoalsPhase extends
AbstractReleasePhase {
* checkout directory. For some SCMs, the project root directory is not the
* checkout directory itself, but a SCM-specific subdirectory.
*
- * @param checkoutDirectory The checkout directory as
java.io.File
- * @param relativePathProjectDirectory The relative path of the project
directory within the checkout
+ * @param checkoutDirectory the checkout directory as
java.io.File
+ * @param relativePathProjectDirectory the relative path of the project
directory within the checkout
* directory or ""
- * @return The working directory
+ * @return the working directory
*/
protected File determineWorkingDirectory(File checkoutDirectory, String
relativePathProjectDirectory) {
File workingDirectory = checkoutDirectory;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitDevelopmentPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitDevelopmentPhase.java
index 4badb570..6aacdd89 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitDevelopmentPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitDevelopmentPhase.java
@@ -39,7 +39,7 @@ import
org.apache.maven.shared.release.scm.ScmRepositoryConfigurator;
*/
public abstract class AbstractScmCommitDevelopmentPhase extends
AbstractScmCommitPhase {
/**
- * The format for the
+ * The format for the.
*/
private final String rollbackMessageFormat;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitPhase.java
index 33135230..ecec1318 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitPhase.java
@@ -120,9 +120,9 @@ public abstract class AbstractScmCommitPhase extends
AbstractReleasePhase {
* @param reactorProjects a {@link java.util.List} object
* @param result a {@link
org.apache.maven.shared.release.ReleaseResult} object
* @param simulating a boolean
- * @throws org.apache.maven.shared.release.scm.ReleaseScmCommandException
if any.
- * @throws org.apache.maven.shared.release.ReleaseExecutionException
if any.
- * @throws
org.apache.maven.shared.release.scm.ReleaseScmRepositoryException if any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException
if any
+ * @throws org.apache.maven.shared.release.scm.ReleaseScmCommandException
if any
+ * @throws
org.apache.maven.shared.release.scm.ReleaseScmRepositoryException if any
*/
protected abstract void runLogic(
ReleaseDescriptor releaseDescriptor,
@@ -139,9 +139,9 @@ public abstract class AbstractScmCommitPhase extends
AbstractReleasePhase {
* @param releaseEnvironment a {@link
org.apache.maven.shared.release.env.ReleaseEnvironment} object
* @param reactorProjects a {@link java.util.List} object
* @param message a {@link java.lang.String} object
- * @throws
org.apache.maven.shared.release.scm.ReleaseScmRepositoryException if any.
- * @throws org.apache.maven.shared.release.ReleaseExecutionException
if any.
- * @throws org.apache.maven.shared.release.scm.ReleaseScmCommandException
if any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException
if any
+ * @throws org.apache.maven.shared.release.scm.ReleaseScmCommandException
if any
+ * @throws
org.apache.maven.shared.release.scm.ReleaseScmRepositoryException if any
*/
protected void performCheckins(
ReleaseDescriptor releaseDescriptor,
@@ -230,7 +230,7 @@ public abstract class AbstractScmCommitPhase extends
AbstractReleasePhase {
* <p>validateConfiguration.</p>
*
* @param releaseDescriptor a {@link
org.apache.maven.shared.release.config.ReleaseDescriptor} object
- * @throws org.apache.maven.shared.release.ReleaseFailureException if any.
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if any
*/
protected void validateConfiguration(ReleaseDescriptor releaseDescriptor)
throws ReleaseFailureException {
if (releaseDescriptor.getScmReleaseLabel() == null) {
@@ -244,7 +244,7 @@ public abstract class AbstractScmCommitPhase extends
AbstractReleasePhase {
* @param reactorProjects a {@link java.util.List} object
* @param releaseDescriptor a {@link
org.apache.maven.shared.release.config.ReleaseDescriptor} object
* @return a {@link java.lang.String} object
- * @throws org.apache.maven.shared.release.ReleaseExecutionException if
any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any
*/
protected String createMessage(List<MavenProject> reactorProjects,
ReleaseDescriptor releaseDescriptor)
throws ReleaseExecutionException {
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RemoveScmTagPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RemoveScmTagPhase.java
index 70cb8672..596c8812 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RemoveScmTagPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RemoveScmTagPhase.java
@@ -47,7 +47,7 @@ import org.apache.maven.shared.release.util.ReleaseUtil;
import static java.util.Objects.requireNonNull;
/**
- * Remove tag from SCM repository during rollback
+ * Remove tag from SCM repository during rollback.
*/
@Singleton
@Named("remove-scm-tag")
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomVersionsPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomVersionsPhase.java
index 72c57482..fec9d949 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomVersionsPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomVersionsPhase.java
@@ -34,7 +34,7 @@ import org.apache.maven.shared.release.scm.ScmTranslator;
import org.apache.maven.shared.release.transform.ModelETLFactory;
/**
- * Rewrite POMs for future development
+ * Rewrite POMs for future development.
*
* @author <a href="mailto:[email protected]";>Brett Porter</a>
*/
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java
index 954f82a4..c05b927a 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForDevelopmentPhase.java
@@ -35,7 +35,7 @@ import org.apache.maven.shared.release.scm.ScmTranslator;
import org.apache.maven.shared.release.transform.ModelETLFactory;
/**
- * Rewrite POMs for future development
+ * Rewrite POMs for future development.
*
* @author <a href="mailto:[email protected]";>Brett Porter</a>
*/
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/IdentifiedScm.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/IdentifiedScm.java
index 1cf9ce79..590b2e15 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/IdentifiedScm.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/IdentifiedScm.java
@@ -22,7 +22,7 @@ import org.apache.maven.model.Scm;
/**
* Unlike repositories the scm of the Project Model doesn't have an id.
- * This makes it quite hard to bind it to the credentials of a server as
specified in the settings.xml
+ * This makes it quite hard to bind it to the credentials of a server as
specified in the settings.xml.
*
* @author Robert Scholte
* @since 2.3
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmRepositoryConfigurator.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmRepositoryConfigurator.java
index a406de83..a97e43cc 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmRepositoryConfigurator.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmRepositoryConfigurator.java
@@ -37,9 +37,9 @@ public interface ScmRepositoryConfigurator {
* @param releaseDescriptor the configuration to insert into the repository
* @param settings the settings.xml configuraiton
* @return the repository created
+ * @throws org.apache.maven.scm.manager.NoSuchScmProviderException if the
requested SCM provider is not available
* @throws org.apache.maven.scm.repository.ScmRepositoryException if
it is not possible to create a suitable
* SCM repository
- * @throws org.apache.maven.scm.manager.NoSuchScmProviderException if the
requested SCM provider is not available
*/
ScmRepository getConfiguredRepository(ReleaseDescriptor releaseDescriptor,
Settings settings)
throws ScmRepositoryException, NoSuchScmProviderException;
@@ -60,9 +60,9 @@ public interface ScmRepositoryConfigurator {
* @param releaseDescriptor the configuration to insert into the repository
* @param settings the settings.xml configuraiton
* @return the repository created
+ * @throws org.apache.maven.scm.manager.NoSuchScmProviderException if the
requested SCM provider is not available
* @throws org.apache.maven.scm.repository.ScmRepositoryException if
it is not possible to create a suitable
* SCM repository
- * @throws org.apache.maven.scm.manager.NoSuchScmProviderException if the
requested SCM provider is not available
*/
ScmRepository getConfiguredRepository(String url, ReleaseDescriptor
releaseDescriptor, Settings settings)
throws ScmRepositoryException, NoSuchScmProviderException;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/strategies/DefaultStrategy.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/strategies/DefaultStrategy.java
index fdbe761e..c3c9abc6 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/strategies/DefaultStrategy.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/strategies/DefaultStrategy.java
@@ -47,7 +47,7 @@ public class DefaultStrategy implements Strategy {
private final List<String> performPhases;
/**
- * The phases of release to run to rollback changes
+ * The phases of release to run to rollback changes.
*/
private final List<String> rollbackPhases;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETL.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETL.java
index fc4fe181..b83ec64a 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETL.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETL.java
@@ -34,7 +34,7 @@ public interface ModelETL {
* <p>extract.</p>
*
* @param pomFile a {@link java.io.File} object
- * @throws org.apache.maven.shared.release.ReleaseExecutionException if
any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any
*/
void extract(File pomFile) throws ReleaseExecutionException;
@@ -47,7 +47,7 @@ public interface ModelETL {
* <p>load.</p>
*
* @param pomFile a {@link java.io.File} object
- * @throws org.apache.maven.shared.release.ReleaseExecutionException if
any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any
*/
void load(File pomFile) throws ReleaseExecutionException;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomBuild.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomBuild.java
index fc0f81bc..74ed10c2 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomBuild.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomBuild.java
@@ -31,7 +31,7 @@ import org.apache.maven.model.Resource;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms BUILD element
+ * JDOM2 implementation of poms BUILD element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependency.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependency.java
index 08218eec..9bc7b6e9 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependency.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependency.java
@@ -26,7 +26,7 @@ import
org.apache.maven.shared.release.transform.MavenCoordinate;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms DEPENDENCY element
+ * JDOM2 implementation of poms DEPENDENCY element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependencyManagement.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependencyManagement.java
index 5db9b2d1..cfe6e921 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependencyManagement.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependencyManagement.java
@@ -27,7 +27,7 @@ import org.apache.maven.model.DependencyManagement;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms DEPENDENCYMANAGEMENT element
+ * JDOM2 implementation of poms DEPENDENCYMANAGEMENT element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomExtension.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomExtension.java
index cf7c5236..2a08c35c 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomExtension.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomExtension.java
@@ -23,7 +23,7 @@ import
org.apache.maven.shared.release.transform.MavenCoordinate;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms EXTENSION element
+ * JDOM2 implementation of poms EXTENSION element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
index c460ccc2..d5811b5f 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
@@ -38,7 +38,7 @@ import org.jdom2.Element;
import org.jdom2.Text;
/**
- * JDOM2 implementation of poms PROJECT element
+ * JDOM2 implementation of poms PROJECT element.
*
* @author Robert Scholte
* @since 3.0
@@ -49,8 +49,7 @@ public class JDomModel extends Model {
private final JDomModelBase modelBase;
/**
- * The ReleaseDescriptor after a commit performed
- *
+ * The ReleaseDescriptor after a commit performed.
*/
private final ReleaseDescriptor releaseDescriptor;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomParent.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomParent.java
index bfda08fc..bb078be8 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomParent.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomParent.java
@@ -22,7 +22,7 @@ import org.apache.maven.model.Parent;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms PARENT element
+ * JDOM2 implementation of poms PARENT element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPlugin.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPlugin.java
index 60cc9bc5..60b65252 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPlugin.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPlugin.java
@@ -30,7 +30,7 @@ import
org.apache.maven.shared.release.transform.MavenCoordinate;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms PLUGIN element
+ * JDOM2 implementation of poms PLUGIN element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPluginManagement.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPluginManagement.java
index 57044c7f..00e33183 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPluginManagement.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPluginManagement.java
@@ -28,7 +28,7 @@ import org.apache.maven.model.PluginManagement;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms PLUGINMANAGEMENT element
+ * JDOM2 implementation of poms PLUGINMANAGEMENT element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProfile.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProfile.java
index a8863386..343f0678 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProfile.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProfile.java
@@ -27,7 +27,7 @@ import org.apache.maven.model.Profile;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms PROFILE element
+ * JDOM2 implementation of poms PROFILE element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReportPlugin.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReportPlugin.java
index 792b77f7..da418b56 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReportPlugin.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReportPlugin.java
@@ -27,7 +27,7 @@ import
org.apache.maven.shared.release.transform.MavenCoordinate;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms reports PLUGIN element
+ * JDOM2 implementation of poms reports PLUGIN element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReporting.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReporting.java
index 505f0a38..bef77f51 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReporting.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReporting.java
@@ -28,7 +28,7 @@ import org.apache.maven.model.Reporting;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms REPORTING element
+ * JDOM2 implementation of poms REPORTING element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomScm.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomScm.java
index 7ff2a48e..f15fa846 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomScm.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomScm.java
@@ -22,7 +22,7 @@ import org.apache.maven.model.Scm;
import org.jdom2.Element;
/**
- * JDOM2 implementation of poms SCM element
+ * JDOM2 implementation of poms SCM element.
*
* @author Robert Scholte
* @since 3.0
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomUtils.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomUtils.java
index 4783b2e4..e29b2c8c 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomUtils.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomUtils.java
@@ -25,7 +25,7 @@ import org.jdom2.Namespace;
import org.jdom2.Text;
/**
- * Common JDOM2 functions
+ * Common JDOM2 functions.
*
* @author Robert Scholte
* @since 3.0
@@ -40,8 +40,8 @@ public final class JDomUtils {
* Updates the text value of the given element. The primary purpose of
this method is to preserve any whitespace and
* comments around the original text value.
*
- * @param element The element to update, must not be <code>null</code>.
- * @param value The text string to set, must not be <code>null</code>.
+ * @param element the element to update, must not be <code>null</code>
+ * @param value the text string to set, must not be <code>null</code>
*/
public static void rewriteValue(Element element, String value) {
Text text = null;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/CiFriendlyVersion.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/CiFriendlyVersion.java
index 8526da41..ff49e8a1 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/CiFriendlyVersion.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/CiFriendlyVersion.java
@@ -33,7 +33,8 @@ public class CiFriendlyVersion {
private static final Logger LOGGER =
LoggerFactory.getLogger(CiFriendlyVersion.class);
/**
- * All Maven properties allowed to be referenced in parent versions via
expressions
+ * All Maven properties allowed to be referenced in parent versions via
expressions.
+ *
* @see <a
href="https://maven.apache.org/maven-ci-friendly.html";>CI-Friendly Versions</a>
*/
public static final String REVISION = "revision";
@@ -60,6 +61,7 @@ public class CiFriendlyVersion {
/**
* Rewrites the CI friendly properties in the given properties object
based on the provided version and release descriptor.
+ *
* @param version
* @param properties
* @param releaseDescriptor
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/MavenExpression.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/MavenExpression.java
index f832c092..694be389 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/MavenExpression.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/MavenExpression.java
@@ -48,6 +48,7 @@ public class MavenExpression {
/**
* Extracts the Maven property name from a given expression.
+ *
* @param expression the expression
* @return either {@code null} if value is no expression otherwise the
property referenced in the expression
*/
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/PomFinder.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/PomFinder.java
index 858da49f..817d9f11 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/PomFinder.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/PomFinder.java
@@ -70,7 +70,6 @@ public class PomFinder {
}
/**
- *
* @param originPom the pom File which should be used as blueprint for the
search
* @return <code>true</code> if a pom got parsed successfully,
<code>false</code> otherwise
*/
@@ -92,9 +91,10 @@ public class PomFinder {
/**
* Search for the previously with {@link #parsePom(java.io.File)}
* parsed pom in the given directory.
+ *
* @param startDirectory the initial directory
* @return the pom file which matches the previously parsed pom or
<code>null</code>
- * if no matching pom file could have been found.
+ * if no matching pom file could have been found
*/
public File findMatchingPom(File startDirectory) {
if (!startDirectory.exists()) {
@@ -151,7 +151,8 @@ public class PomFinder {
}
/**
- * Read the {@link PomInfo} from the given pom file
+ * Read the {@link PomInfo} from the given pom file.
+ *
* @param pomFile pom.xml file
* @return the PomInfo or <code>null</code
*/
@@ -185,7 +186,7 @@ public class PomFinder {
return pomInfo;
}
- /***
+ /**
* Data container which helds information about a pom.
* Information may partially be empty.
*/
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/ReleaseUtil.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/ReleaseUtil.java
index f57ba8bd..3fcd7f2a 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/ReleaseUtil.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/ReleaseUtil.java
@@ -110,9 +110,9 @@ public class ReleaseUtil {
* the returned string will be normalized to use the platform's native
line separator. This is basically to save
* another normalization step when writing the string contents back to an
XML file.
*
- * @param file The path to the XML file to read in, must not be
<code>null</code>.
- * @return The string contents of the XML file.
- * @throws IOException If the file could not be opened/read.
+ * @param file the path to the XML file to read in, must not be
<code>null</code>
+ * @return the string contents of the XML file
+ * @throws IOException if the file could not be opened/read
*/
public static String readXmlFile(File file) throws IOException {
return readXmlFile(file, LS);
@@ -127,11 +127,11 @@ public class ReleaseUtil {
/**
* Normalizes the line separators in the specified string.
*
- * @param text The string to normalize, may be <code>null</code>.
- * @param separator The line separator to use for normalization, typically
"\n" or "\r\n", must not be
- * <code>null</code>.
- * @return The input string with normalized line separators or
<code>null</code> if the string was <code>null</code>
- * .
+ * @param text the string to normalize, may be <code>null</code>
+ * @param separator the line separator to use for normalization, typically
"\n" or "\r\n", must not be
+ * <code>null</code>
+ * @return the input string with normalized line separators or
<code>null</code> if the string was <code>null</code>
+ *
*/
public static String normalizeLineEndings(String text, String separator) {
String norm = text;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/DefaultVersionInfo.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/DefaultVersionInfo.java
index d9f0bae1..c24cdbf6 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/DefaultVersionInfo.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/DefaultVersionInfo.java
@@ -89,7 +89,7 @@ public class DefaultVersionInfo implements VersionInfo {
private static final String DIGIT_SEPARATOR_STRING = ".";
- /** Constant <code>STANDARD_PATTERN</code> */
+ /** Constant <code>STANDARD_PATTERN</code>. */
public static final Pattern STANDARD_PATTERN = Pattern.compile(
"^((?:\\d+\\.)*\\d+)" // digit(s) and '.' repeated - followed by
digit (version digits 1.22.0, etc)
+ "([-_])?" // optional - or _ (annotation separator)
@@ -107,7 +107,7 @@ public class DefaultVersionInfo implements VersionInfo {
* SNAPSHOT
*/
// for SNAPSHOT releases only (possible versions include: trunk-SNAPSHOT
or SNAPSHOT)
- /** Constant <code>ALTERNATE_PATTERN</code> */
+ /** Constant <code>ALTERNATE_PATTERN</code>. */
public static final Pattern ALTERNATE_PATTERN =
Pattern.compile("^(SNAPSHOT|[a-zA-Z]+[_-]SNAPSHOT)");
/**
@@ -269,7 +269,7 @@ public class DefaultVersionInfo implements VersionInfo {
*
* @param s the version number
* @return {@code String} increments the input {@code String} as an integer
- * and Preserves any lpad of "0" zeros.
+ * and Preserves any lpad of "0" zeros
*/
protected String incrementVersionString(String s) {
int n = Integer.valueOf(s).intValue() + 1;
@@ -356,10 +356,10 @@ public class DefaultVersionInfo implements VersionInfo {
}
/**
- * Simply joins the items in the list with "." period
+ * Simply joins the items in the list with "." period.
*
- * @return a single {@code String} of the items in the passed list, joined
with a "."
* @param digits {@code List<String>} of digits
+ * @return a single {@code String} of the items in the passed list, joined
with a "."
*/
protected static String joinDigitString(List<String> digits) {
return digits != null ? StringUtils.join(digits.iterator(),
DIGIT_SEPARATOR_STRING) : null;
diff --git
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
index 000520ec..fd61957e 100644
---
a/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
+++
b/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
@@ -19,13 +19,12 @@
package org.apache.maven.shared.release.versions;
/**
- * Represent the different version representations during the release-prepare
phase
- *
+ * Represent the different version representations during the release-prepare
phase.
*/
public interface VersionInfo extends Comparable<VersionInfo> {
/**
- * Returns a string representing the version with a snapshot specification
+ * Returns a string representing the version with a snapshot specification.
*
* @return the snapshot version transformation of the original value
*/
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
index 20ae91bc..bf228d53 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
@@ -43,18 +43,12 @@ import org.codehaus.plexus.util.StringUtils;
* @author <a href="mailto:[email protected]";>Brett Porter</a>
*/
public abstract class AbstractReleaseMojo extends AbstractMojo {
- /**
- */
@Parameter(defaultValue = "${basedir}", readonly = true, required = true)
private File basedir;
- /**
- */
@Parameter(defaultValue = "${settings}", readonly = true, required = true)
private Settings settings;
- /**
- */
@Parameter(defaultValue = "${project}", readonly = true, required = true)
protected MavenProject project;
@@ -71,8 +65,6 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
@Parameter(property = "pomFileName", defaultValue = "${project.file.name}")
private String pomFileName;
- /**
- */
@Parameter(defaultValue = "${reactorProjects}", readonly = true, required
= true)
private List<MavenProject> reactorProjects;
@@ -118,8 +110,8 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
* The role-hint for the {@link
org.apache.maven.shared.release.strategy.Strategy}
* implementation used to specify the phases per goal.
*
- * @since 3.0.0-M5
* @see org.apache.maven.shared.release.strategies.DefaultStrategy
+ * @since 3.0.0-M5
*/
@Parameter(defaultValue = "default", property = "releaseStrategyId")
private String releaseStrategyId;
@@ -133,7 +125,7 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
/**
* Gets the environment settings configured for this release.
*
- * @return The release environment, never <code>null</code>.
+ * @return the release environment, never <code>null</code>
*/
protected ReleaseEnvironment getReleaseEnvironment() {
return new DefaultReleaseEnvironment()
@@ -147,7 +139,7 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
/**
* Creates the release descriptor from the various goal parameters.
*
- * @return The release descriptor, never <code>null</code>.
+ * @return the release descriptor, never <code>null</code>
*/
protected ReleaseDescriptorBuilder createReleaseDescriptor() {
ReleaseDescriptorBuilder descriptor = new ReleaseDescriptorBuilder();
@@ -209,7 +201,7 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
/**
* Sets the component used to perform release actions.
*
- * @param releaseManager The release manager implementation to use, must
not be <code>null</code>.
+ * @param releaseManager the release manager implementation to use, must
not be <code>null</code>
*/
void setReleaseManager(ReleaseManager releaseManager) {
this.releaseManager = releaseManager;
@@ -218,7 +210,7 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
/**
* Gets the effective settings for this build.
*
- * @return The effective settings for this build, never <code>null</code>.
+ * @return the effective settings for this build, never <code>null</code>
*/
Settings getSettings() {
return settings;
@@ -231,7 +223,7 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
/**
* Sets the base directory of the build.
*
- * @param basedir The build's base directory, must not be
<code>null</code>.
+ * @param basedir the build's base directory, must not be <code>null</code>
*/
public void setBasedir(File basedir) {
this.basedir = basedir;
@@ -242,7 +234,7 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
}
/**
- * only used for unit tests in which some required values of the project
would be null
+ * Only used for unit tests in which some required values of the project
would be null.
*/
protected MavenProject getProject() {
return this.project;
@@ -251,7 +243,7 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
/**
* Gets the list of projects in the build reactor.
*
- * @return The list of reactor project, never <code>null</code>.
+ * @return the list of reactor project, never <code>null</code>
*/
public List<MavenProject> getReactorProjects() {
return reactorProjects;
@@ -260,7 +252,7 @@ public abstract class AbstractReleaseMojo extends
AbstractMojo {
/**
* Add additional arguments.
*
- * @param argument The argument to add, must not be <code>null</code>.
+ * @param argument the argument to add, must not be <code>null</code>
*/
protected void addArgument(String argument) {
if (arguments != null) {
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReadReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReadReleaseMojo.java
index 0c6d1462..78004064 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReadReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReadReleaseMojo.java
@@ -44,14 +44,16 @@ public abstract class AbstractScmReadReleaseMojo extends
AbstractReleaseMojo {
* Currently the POM does not allow to specify a server id for the SCM
section.
* <p>
* Explicit authentication information provided via {@link #username},
{@link #password} or {@link #privateKey} will take precedence.
- * @since 3.2.0
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html";>SCM
Authentication</a>
+ * @since 3.2.0
*/
@Parameter(property = "project.scm.id", defaultValue = "${project.scm.id}")
private String serverId;
/**
* The username to use for authentication with the SCM.
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html";>SCM
Authentication</a>
*/
@Parameter(property = "username")
@@ -59,6 +61,7 @@ public abstract class AbstractScmReadReleaseMojo extends
AbstractReleaseMojo {
/**
* The password to use for authentication with the SCM.
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html";>SCM
Authentication</a>
*/
@Parameter(property = "password")
@@ -66,8 +69,9 @@ public abstract class AbstractScmReadReleaseMojo extends
AbstractReleaseMojo {
/**
* The path to the SSH private key to use for authentication with the SCM.
- * @since 3.2.0
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html";>SCM
Authentication</a>
+ * @since 3.2.0
*/
@Parameter(property = "privateKey")
private File privateKey;
@@ -77,9 +81,9 @@ public abstract class AbstractScmReadReleaseMojo extends
AbstractReleaseMojo {
* The key is the scm prefix and the value is the role hint/provider id of
the
* {@link org.apache.maven.scm.provider.ScmProvider}.
*
- * @since 2.0-beta-6
* @see ScmManager#setScmProviderImplementation(String, String)
* @see <a href="https://maven.apache.org/scm/scms-overview.html";>SCM
Providers</a>
+ * @since 2.0-beta-6
*/
@Parameter
private Map<String, String> providerImplementations;
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReadWriteReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReadWriteReleaseMojo.java
index 424028e3..fa6b916c 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReadWriteReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReadWriteReleaseMojo.java
@@ -73,6 +73,7 @@ public abstract class AbstractScmReadWriteReleaseMojo extends
AbstractScmReadRel
* Whether to push changes to the upstream repository or not.
* Only applicable to distributed version control like Git.
* Is set to <code>true</code> by default to preserve backward
compatibility.
+ *
* @since 2.1
*/
@Parameter(defaultValue = "true", property = "pushChanges")
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
index f0af488f..d5b5aa6f 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
@@ -147,7 +147,7 @@ public class BranchReleaseMojo extends
AbstractScmReadWriteReleaseMojo {
private boolean addSchema;
/**
- * currently only implemented with svn scm. Enable a workaround to prevent
issue
+ * Currently only implemented with svn scm. Enable a workaround to prevent
issue
* due to svn client > 1.5.0
(https://issues.apache.org/jira/browse/SCM-406)
*
* @since 2.0
@@ -196,8 +196,8 @@ public class BranchReleaseMojo extends
AbstractScmReadWriteReleaseMojo {
* The role-hint for the {@link
org.apache.maven.shared.release.policy.version.VersionPolicy}
* implementation used to calculate the project versions.
*
- * @since 3.0.0-M5
* @see org.apache.maven.shared.release.policies.DefaultVersionPolicy
+ * @since 3.0.0-M5
*/
@Parameter(defaultValue = "default", property = "projectVersionPolicyId")
private String projectVersionPolicyId;
@@ -214,8 +214,8 @@ public class BranchReleaseMojo extends
AbstractScmReadWriteReleaseMojo {
* The role-hint for the {@link
org.apache.maven.shared.release.policy.naming.NamingPolicy}
* implementation used to calculate the project names.
*
- * @since 3.0.0-M5
* @see org.apache.maven.shared.release.policies.DefaultNamingPolicy
+ * @since 3.0.0-M5
*/
@Parameter(property = "projectNamingPolicyId")
private String projectBranchNamingPolicyId;
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
index 64bfe149..e78eb829 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
@@ -156,10 +156,10 @@ public class PerformReleaseMojo extends
AbstractScmReadReleaseMojo {
}
}
- /** Just here so it may be overridden by StageReleaseMojo */
+ /** Just here so it may be overridden by StageReleaseMojo. */
void setDeploymentRepository() {}
- /** Just here so it may be overridden by StageReleaseMojo */
+ /** Just here so it may be overridden by StageReleaseMojo. */
void createGoals() {
if (goals == null) {
// set default
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
index 5e21da6e..796baf62 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
@@ -108,6 +108,7 @@ public class PrepareReleaseMojo extends
AbstractScmReadWriteReleaseMojo {
/**
* Comma separated profiles to enable on release prepare, in addition to
active profiles for project execution.
+ *
* @since 3.0.0
*/
@Parameter(property = "preparationProfiles")
@@ -243,8 +244,8 @@ public class PrepareReleaseMojo extends
AbstractScmReadWriteReleaseMojo {
* The role-hint for the {@link
org.apache.maven.shared.release.policy.version.VersionPolicy}
* implementation used to calculate the project versions.
*
- * @since 2.5.1
* @see org.apache.maven.shared.release.policies.DefaultVersionPolicy
+ * @since 2.5.1
*/
@Parameter(defaultValue = "default", property = "projectVersionPolicyId")
private String projectVersionPolicyId;
@@ -261,8 +262,8 @@ public class PrepareReleaseMojo extends
AbstractScmReadWriteReleaseMojo {
* The role-hint for the {@link
org.apache.maven.shared.release.policy.naming.NamingPolicy}
* implementation used to calculate the project branch and tag names.
*
- * @since 3.0.0-M1
* @see org.apache.maven.shared.release.policies.DefaultNamingPolicy
+ * @since 3.0.0-M1
*/
@Parameter(property = "projectNamingPolicyId")
private String projectTagNamingPolicyId;
@@ -380,8 +381,8 @@ public class PrepareReleaseMojo extends
AbstractScmReadWriteReleaseMojo {
* <p>prepareRelease.</p>
*
* @param generateReleasePoms a boolean
- * @throws org.apache.maven.plugin.MojoExecutionException if any.
- * @throws org.apache.maven.plugin.MojoFailureException if any.
+ * @throws org.apache.maven.plugin.MojoExecutionException if any
+ * @throws org.apache.maven.plugin.MojoFailureException if any
*/
protected void prepareRelease(boolean generateReleasePoms) throws
MojoExecutionException, MojoFailureException {
// this is here so the subclass can call it without getting the extra
generateReleasePoms check in execute()
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
index 8e3586ab..05642c90 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
@@ -38,8 +38,8 @@ import
org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
*
href="https://maven.apache.org/plugins/maven-release-plugin/usage/rollback-release.html";
*
>https://maven.apache.org/plugins/maven-release-plugin/usage/rollback-release.html</a>.
*
- * @since 2.0-beta-5
* @author Edwin Punzalan
+ * @since 2.0-beta-5
*/
@Mojo(name = "rollback", aggregator = true)
public class RollbackReleaseMojo extends AbstractScmReadWriteReleaseMojo {
diff --git
a/maven-release-policies/maven-release-oddeven-policy/src/main/java/org/apache/maven/shared/release/policy/oddeven/OddEvenVersionPolicy.java
b/maven-release-policies/maven-release-oddeven-policy/src/main/java/org/apache/maven/shared/release/policy/oddeven/OddEvenVersionPolicy.java
index 35640f51..239ca6cf 100644
---
a/maven-release-policies/maven-release-oddeven-policy/src/main/java/org/apache/maven/shared/release/policy/oddeven/OddEvenVersionPolicy.java
+++
b/maven-release-policies/maven-release-oddeven-policy/src/main/java/org/apache/maven/shared/release/policy/oddeven/OddEvenVersionPolicy.java
@@ -40,7 +40,6 @@ import org.eclipse.sisu.Description;
* <li><code>1.0.1-SNAPSHOT</code> gets <code>1.0.2</code> for next
release,</li>
* <li><code>1.0.2</code> gets <code>1.0.3-SNAPSHOT</code> for next
development version.</li>
* </ul>
- *
*/
@Singleton
@Named("OddEvenVersionPolicy")
diff --git
a/maven-release-policies/maven-release-semver-policy/src/main/java/org/apache/maven/shared/release/policy/semver/SemVerVersionPolicy.java
b/maven-release-policies/maven-release-semver-policy/src/main/java/org/apache/maven/shared/release/policy/semver/SemVerVersionPolicy.java
index 37f19765..3a47d3bf 100644
---
a/maven-release-policies/maven-release-semver-policy/src/main/java/org/apache/maven/shared/release/policy/semver/SemVerVersionPolicy.java
+++
b/maven-release-policies/maven-release-semver-policy/src/main/java/org/apache/maven/shared/release/policy/semver/SemVerVersionPolicy.java
@@ -30,8 +30,7 @@ import org.semver.Version;
import org.semver.Version.Element;
/**
- *
- * Uses SemVer implementation to increase minor element when resolving the
development version
+ * Uses SemVer implementation to increase minor element when resolving the
development version.
*/
@Singleton
@Named("SemVerVersionPolicy")
