From 1d63b5217bb7ca93122af951f97d7bf24954ac3a Mon Sep 17 00:00:00 2001 From: Carlos Chacin Date: Wed, 8 Jan 2020 00:58:27 -0800 Subject: [PATCH] [MRELEASE-1036] Fix JavaDoc for JDK 8 --- .../release/config/ReleaseDescriptor.java | 15 ++++++++------ .../release/policy/naming/NamingPolicy.java | 6 +++++- .../release/policy/version/VersionPolicy.java | 14 +++++++++++-- .../shared/release/strategy/Strategy.java | 20 +++++-------------- .../shared/release/versions/Version.java | 3 ++- maven-release-manager/pom.xml | 9 +++++++++ .../maven/shared/release/ReleaseManager.java | 2 +- .../release/exec/ForkedMavenExecutor.java | 2 +- .../phase/CheckDependencySnapshotsPhase.java | 4 ++-- .../release/phase/MapVersionsPhase.java | 2 +- .../shared/release/scm/ScmTranslator.java | 4 ++-- .../maven/shared/release/util/PomFinder.java | 6 +++--- .../release/versions/DefaultVersionInfo.java | 19 +++++++++--------- .../plugins/release/PrepareReleaseMojo.java | 2 +- .../FlatMultiModuleMavenProjectStub.java | 2 ++ 15 files changed, 65 insertions(+), 45 deletions(-) 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 a6d03c2bd..467067530 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 @@ -109,7 +109,7 @@ public interface ReleaseDescriptor boolean isUpdateVersionsToSnapshot(); /** - * Get nOTE : currently only implemented with svn scm. Enable a workaround to prevent issue due to svn client > + * Get nOTE : 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). * * @return boolean @@ -415,20 +415,23 @@ public interface ReleaseDescriptor String getReleaseStrategyId(); /** - * Retrieve the original version for the resolved snapshot dependency. + * @return {@code String} The original version for the resolved snapshot dependency. * + * @param artifactKey the artifact key {@code String} */ String getDependencyOriginalVersion( String artifactKey ); /** - * Retrieve the release version for the resolved snapshot dependency. + * @return {@code String} the release version for the resolved snapshot dependency. * + * @param artifactKey the artifact key {@code String} */ String getDependencyReleaseVersion( String artifactKey ); /** - * Retrieve the release version for the resolved snapshot dependency. + * @return {@code String} the release version for the resolved snapshot dependency. * + * @param artifactKey the artifact key {@code String} */ String getDependencyDevelopmentVersion( String artifactKey ); @@ -440,9 +443,9 @@ public interface ReleaseDescriptor String getProjectReleaseVersion( String key ); /** - * Method getOriginalScmInfo. + * @return the original {@code Scm} information. * - * @return Map + * @param projectKey the project key {@code String} */ Scm getOriginalScmInfo( String projectKey ); 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 3435c2436..2257df390 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,7 +29,11 @@ public interface NamingPolicy { /** - * Calculation of the name used for branching or tagging. + * @return the calculation of the name used for branching or tagging. + * + * @param request the {@code NamingPolicyRequest} + * + * @throws 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 a902bdfb0..55bffae7f 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,13 +30,23 @@ public interface VersionPolicy { /** - * Calculation of the release version from development state. + * @return the calculation of the release version from development state. + * + * @param request the {@code VersionPolicyRequest} + * + * @throws PolicyException if exception in the policy + * @throws VersionParseException if exception parsing the version */ VersionPolicyResult getReleaseVersion( VersionPolicyRequest request ) throws PolicyException, VersionParseException; /** - * Calculation of the next development version from release state. + * @return the calculation of the next development version from release state. + * + * @param request the {@code VersionPolicyRequest} + * + * @throws PolicyException if exception in the policy + * @throws VersionParseException if exception parsing the version */ VersionPolicyResult getDevelopmentVersion( VersionPolicyRequest request ) throws PolicyException, VersionParseException; 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 faca146f5..43300b012 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 @@ -32,37 +32,27 @@ public interface Strategy { /** - * The release phases to execute the calling the prepare goal - * - * @return + * @return The release phases to execute the calling the prepare goal */ List getPreparePhases(); /** - * The release phases to execute the calling the perform goal - * - * @return + * @return The release phases to execute the calling the perform goal */ List getPerformPhases(); /** - * The release phases to execute the calling the branch goal - * - * @return + * @return The release phases to execute the calling the branch goal */ List getBranchPhases(); /** - * The release phases to execute the calling the rollback goal - * - * @return + * @return The release phases to execute the calling the rollback goal */ List getRollbackPhases(); /** - * The release phases to execute the calling the update-versions goal - * - * @return + * @return The release phases to execute the calling the update-versions goal */ List 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 c408756fa..2fdf1c1ed 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 @@ -216,7 +216,8 @@ protected static String getVersionString( Version info, String buildSpecifier, S /** * Simply joins the items in the list with "." period * - * @param digits + * @return a {@code String} containing the items in the list joined by "." period + * @param digits the list of digits {@code List} */ protected static String joinDigitString( List digits ) { diff --git a/maven-release-manager/pom.xml b/maven-release-manager/pom.xml index 1fd90971d..4ce127412 100644 --- a/maven-release-manager/pom.xml +++ b/maven-release-manager/pom.xml @@ -260,6 +260,15 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + + + org.apache.maven.shared.release.config + + 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 cab46b28c..fdfb89ffe 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 @@ -55,7 +55,7 @@ void perform( ReleasePerformRequest performRequest ) * Clean a release. * * @param cleanRequest all clean arguments - * @throws ReleaseFailureException + * @throws ReleaseFailureException if exception when releasing * @since 2.3 */ void clean( ReleaseCleanRequest cleanRequest ) throws ReleaseFailureException; 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 2db71e948..e4a55391a 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 @@ -50,7 +50,7 @@ public class ForkedMavenExecutor @Requirement private CommandLineFactory commandLineFactory; - /** + /* * @noinspection UseOfSystemOutOrSystemErr */ @Override diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckDependencySnapshotsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckDependencySnapshotsPhase.java index b19b44635..9f9efe317 100644 --- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckDependencySnapshotsPhase.java +++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckDependencySnapshotsPhase.java @@ -49,9 +49,9 @@ * Check the dependencies of all projects being released to see if there are any unreleased snapshots. * * @author Brett Porter - * @todo plugins with no version will be resolved to RELEASE which is not a snapshot, but remains unresolved to this point. This is a potential hole in the check, and should be revisited after the release pom writing is done and resolving versions to verify whether it is. - * @todo plugins injected by the lifecycle are not tested here. They will be injected with a RELEASE version so are covered under the above point. */ + // TODO plugins with no version will be resolved to RELEASE which is not a snapshot, but remains unresolved to this point. This is a potential hole in the check, and should be revisited after the release pom writing is done and resolving versions to verify whether it is. + // TODO plugins injected by the lifecycle are not tested here. They will be injected with a RELEASE version so are covered under the above point. @Component( role = ReleasePhase.class, hint = "check-dependency-snapshots" ) public class CheckDependencySnapshotsPhase extends AbstractReleasePhase diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/MapVersionsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/MapVersionsPhase.java index 5d1372fec..68d2e7ab1 100644 --- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/MapVersionsPhase.java +++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/MapVersionsPhase.java @@ -50,8 +50,8 @@ *
release:update-versions
map-development-versions; RD.isBranchCreation() = false
* * - *

* + * * * * diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmTranslator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmTranslator.java index f735edd10..693f6469a 100644 --- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmTranslator.java +++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmTranslator.java @@ -23,8 +23,8 @@ * Translate the SCM information after tagging/reverting to trunk. * * @author Brett Porter - * @todo move this API into SCM? */ +// TODO move this API into SCM? public interface ScmTranslator { /** @@ -58,7 +58,7 @@ public interface ScmTranslator /** * Translates an ScmFile path to a path relative to the working directory. * - * @param path + * @param path the ScmFile path * @return the relative path with OS specific File separator * @since 2.3.1 */ 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 a4bd633d4..df2519222 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 @@ -45,7 +45,7 @@ *

Usage:

*

PomFinder is a statefull class. One instance of this class intended * for a singular use! You need to create a new instance if you like - * to search for another pom.

*
    *
  1. * Parse an origin pom in a given directory with {@link #parsePom(java.io.File)} @@ -98,9 +98,9 @@ public boolean parsePom( File originPom ) /** * Search for the previously with {@link #parsePom(java.io.File)} * parsed pom in the given directory. - * @param startDirectory + * @param startDirectory the initial directory * @return the pom file which matches the previously parsed pom or null - * if no matching pom file could have been found. + * if no matching pom file could have been found. */ public File findMatchingPom( File startDirectory ) { 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 9043bdb7d..71b496329 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 @@ -33,27 +33,24 @@ /** * This compares and increments versions for a common java versioning scheme. - *

    + *

    * The supported version scheme has the following parts.
    * component-digits-annotation-annotationRevision-buildSpecifier
    * Example:
    * my-component-1.0.1-alpha-2-SNAPSHOT - *

    - *

      Terms: + * Terms: + *
        *
      • component - name of the versioned component (log4j, commons-lang, etc) *
      • digits - Numeric digits with at least one "." period. (1.0, 1.1, 1.01, 1.2.3, etc) *
      • annotationRevision - Integer qualifier for the annotation. (4 as in RC-4) *
      • buildSpecifier - Additional specifier for build. (SNAPSHOT, or build number like "20041114.081234-2") *
      * Digits is the only required piece of the version string, and must contain at lease one "." period. - *

      * Implementation details:
      * The separators "_" and "-" between components are also optional (though they are usually recommended).
      * Example:
      * log4j-1.2.9-beta-9-SNAPSHOT == log4j1.2.9beta9SNAPSHOT == log4j_1.2.9_beta_9_SNAPSHOT - *

      * Leading zeros are significant when performing comparisons. - *

      * TODO: this parser is better than DefaultArtifactVersion - replace it with this (but align naming) and then remove * this from here. */ @@ -116,7 +113,8 @@ public class DefaultVersionInfo /** * Constructs this object and parses the supplied version string. * - * @param version + * @param version the version string + * @throws VersionParseException if an exception during parsing the input */ public DefaultVersionInfo( String version ) throws VersionParseException @@ -274,7 +272,9 @@ public int hashCode() * Takes a string and increments it as an integer. * Preserves any lpad of "0" zeros. * - * @param s + * @return {@code String} increments the input {@code String} as an integer + * and Preserves any lpad of "0" zeros. + * @param s the version number */ protected String incrementVersionString( String s ) { @@ -374,7 +374,8 @@ protected static String getVersionString( DefaultVersionInfo info, String buildS /** * Simply joins the items in the list with "." period * - * @param digits + * @return a single {@code String} of the items in the passed list, joined with a "." + * @param digits {@code List} of digits */ protected static String joinDigitString( List digits ) { 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 1c3e057d5..63b5f745e 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 @@ -44,8 +44,8 @@ * @author Jason van Zyl * @author Brett Porter * @version $Id$ - * @todo [!] check how this works with version ranges */ +// TODO [!] check how this works with version ranges @Mojo( name = "prepare", aggregator = true, requiresDependencyCollection = ResolutionScope.TEST ) public class PrepareReleaseMojo extends AbstractScmReleaseMojo diff --git a/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/FlatMultiModuleMavenProjectStub.java b/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/FlatMultiModuleMavenProjectStub.java index 03b8cd461..afb33f87b 100644 --- a/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/FlatMultiModuleMavenProjectStub.java +++ b/maven-release-plugin/src/test/java/org/apache/maven/plugins/release/stubs/FlatMultiModuleMavenProjectStub.java @@ -34,6 +34,8 @@ * Just overriding the ones I need for this plugin. * * @author Maria Odea Ching + */ +/* * @noinspection ClassNameSameAsAncestorName */ public class FlatMultiModuleMavenProjectStub

MapVersionsPhase
MapVersionsPhase fieldmap-release-versionsmap-branch-versionsmap-development-versions