From b66bdb9cbc383fd4cc875006afe9fe6d4de26397 Mon Sep 17 00:00:00 2001 From: Michael Osipov Date: Sun, 12 Feb 2017 01:10:50 +0100 Subject: [PATCH] [MNG-6150] Javadoc improvements for 3.5.0 * Remove duplicate plugin configuration * Add workaround for Javadoc locale * Clean up errors reported by Javadoc 7 Note: Javadoc 8 fails immediately because Modello generates invalid Javadoc --- .../org/apache/maven/artifact/Artifact.java | 2 +- .../repository/ArtifactRepository.java | 1 - .../artifact/versioning/VersionRange.java | 4 +-- .../org/apache/maven/repository/Proxy.java | 6 ++-- .../legacy/metadata/ArtifactMetadata.java | 8 ++--- .../artifact/versioning/VersionRangeTest.java | 4 +-- .../maven/artifact/ArtifactScopeEnum.java | 2 -- .../artifact/manager/DefaultWagonManager.java | 2 +- .../DefaultRepositoryMetadataManager.java | 10 +++--- .../SnapshotArtifactRepositoryMetadata.java | 2 +- .../resolver/DebugResolutionListener.java | 2 +- .../resolver/DefaultArtifactResolver.java | 2 +- .../maven/project/MavenProjectBuilder.java | 2 +- .../DefaultModelInheritanceAssembler.java | 10 +++--- .../AbstractStringBasedModelInterpolator.java | 6 ++-- .../RegexBasedModelInterpolator.java | 2 +- .../maven/repository/MetadataGraph.java | 5 --- .../repository/MetadataResolutionRequest.java | 2 +- .../repository/MetadataResolutionResult.java | 2 +- .../legacy/DefaultWagonManager.java | 12 +++---- .../DefaultArtifactRepositoryFactory.java | 2 +- .../DefaultLegacyArtifactCollector.java | 14 ++++---- .../DefaultConflictResolverFactory.java | 2 +- .../conflict/NewestConflictResolver.java | 2 +- .../conflict/OldestConflictResolver.java | 2 +- .../AbstractVersionTransformation.java | 6 ++-- .../DefaultArtifactCollectorTest.java | 4 +-- .../AbstractMavenLifecycleParticipant.java | 2 +- .../maven/DefaultArtifactFilterManager.java | 2 +- ...DependencyResolutionRequiredException.java | 2 +- .../repository/MavenArtifactRepository.java | 4 +-- .../metadata/AbstractRepositoryMetadata.java | 4 +-- .../metadata/RepositoryMetadata.java | 2 +- .../resolver/ArtifactResolutionResult.java | 4 +-- .../artifact/resolver/ResolutionNode.java | 2 +- .../filter/ExcludesArtifactFilter.java | 2 +- .../filter/IncludesArtifactFilter.java | 2 +- .../DefaultMavenExecutionRequest.java | 2 +- .../execution/MavenExecutionRequest.java | 26 ++++++++------- .../scope/WeakMojoExecutionListener.java | 5 +-- .../lifecycle/DefaultLifecycleExecutor.java | 4 +-- .../maven/lifecycle/DefaultLifecycles.java | 2 +- .../maven/lifecycle/MavenExecutionPlan.java | 12 +++---- ...faultLifecycleExecutionPlanCalculator.java | 4 +-- .../lifecycle/internal/DependencyContext.java | 2 +- .../maven/lifecycle/internal/GoalTask.java | 2 +- .../internal/MojoDescriptorCreator.java | 4 +-- .../lifecycle/internal/ProjectBuildList.java | 2 +- .../lifecycle/internal/ProjectIndex.java | 2 +- .../maven/lifecycle/internal/TaskSegment.java | 2 +- .../internal/builder/BuilderCommon.java | 2 +- .../maven/lifecycle/mapping/Lifecycle.java | 8 ++--- .../plugin/DefaultBuildPluginManager.java | 4 +-- .../PluginParameterExpressionEvaluator.java | 14 ++++---- .../internal/DefaultMavenPluginManager.java | 4 +-- .../DuplicateArtifactAttachmentException.java | 2 +- .../apache/maven/project/MavenProject.java | 32 +++++++++---------- .../apache/maven/project/ProjectSorter.java | 2 +- .../artifact/ActiveProjectArtifact.java | 2 +- .../project/artifact/MavenMetadataSource.java | 6 ++-- .../properties/internal/SystemProperties.java | 6 ++-- .../settings/DefaultMavenSettingsBuilder.java | 2 +- .../toolchain/DefaultToolchainManager.java | 2 +- .../maven/toolchain/ToolchainManager.java | 6 ++-- .../internal/ProjectBuildListTest.java | 2 +- .../maven/plugin/PluginManagerTest.java | 6 ++-- .../artifact/MavenMetadataSourceTest.java | 2 +- .../org/apache/maven/cli/CleanArgument.java | 2 +- .../java/org/apache/maven/cli/MavenCli.java | 8 ++--- .../model/building/DefaultModelBuilder.java | 2 +- .../maven/model/building/ModelBuilder.java | 4 --- .../model/building/ModelBuildingRequest.java | 4 +-- .../apache/maven/model/building/Result.java | 23 ++++--------- .../StringSearchModelInterpolator.java | 2 +- .../maven/model/merge/MavenModelMerger.java | 6 ++-- .../validation/DefaultModelValidator.java | 2 +- .../java/org/apache/maven/plugin/Mojo.java | 2 +- .../plugin/descriptor/MojoDescriptor.java | 4 +-- .../plugin/descriptor/PluginDescriptor.java | 4 +-- .../descriptor/PluginDescriptorBuilder.java | 2 +- .../maven/plugin/logging/SystemStreamLog.java | 2 +- pom.xml | 17 +++++----- 82 files changed, 189 insertions(+), 210 deletions(-) diff --git a/maven-artifact/src/main/java/org/apache/maven/artifact/Artifact.java b/maven-artifact/src/main/java/org/apache/maven/artifact/Artifact.java index 6cc002263e..9546433a04 100644 --- a/maven-artifact/src/main/java/org/apache/maven/artifact/Artifact.java +++ b/maven-artifact/src/main/java/org/apache/maven/artifact/Artifact.java @@ -48,7 +48,7 @@ public interface Artifact Pattern VERSION_FILE_PATTERN = Pattern.compile( "^(.*)-([0-9]{8}.[0-9]{6})-([0-9]+)$" ); - // TODO: into artifactScope handler + // TODO into artifactScope handler String SCOPE_COMPILE = "compile"; diff --git a/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java b/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java index 9ef30387b3..0b33345c73 100644 --- a/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java +++ b/maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java @@ -79,7 +79,6 @@ public interface ArtifactRepository /** * * @param artifact - * @return * @since 3.0-alpha-3 */ Artifact find( Artifact artifact ); diff --git a/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/VersionRange.java b/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/VersionRange.java index 7181db0286..502b0e73a1 100644 --- a/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/VersionRange.java +++ b/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/VersionRange.java @@ -295,7 +295,7 @@ public class VersionRange // original recommended version version = restriction.recommendedVersion; } -/* TODO: should throw this immediately, but need artifact +/* TODO should throw this immediately, but need artifact else { throw new OverConstrainedVersionException( "Restricting incompatible version ranges" ); @@ -518,7 +518,7 @@ public class VersionRange public ArtifactVersion matchVersion( List versions ) { - // TODO: could be more efficient by sorting the list and then moving along the restrictions in order? + // TODO could be more efficient by sorting the list and then moving along the restrictions in order? ArtifactVersion matched = null; for ( ArtifactVersion version : versions ) diff --git a/maven-artifact/src/main/java/org/apache/maven/repository/Proxy.java b/maven-artifact/src/main/java/org/apache/maven/repository/Proxy.java index ea2c0238e7..e42f1ed8f8 100644 --- a/maven-artifact/src/main/java/org/apache/maven/repository/Proxy.java +++ b/maven-artifact/src/main/java/org/apache/maven/repository/Proxy.java @@ -148,9 +148,9 @@ public class Proxy } /** - * Get the type of the proxy server. + * Get the protocol of the proxy server. * - * @return the type of the proxy server + * @return the protocol of the proxy server */ public String getProtocol() { @@ -158,7 +158,7 @@ public class Proxy } /** - * @param type the type of the proxy server like SOCKSv4 + * @param protocol the protocol of the proxy server like SOCKSv4 */ public void setProtocol( String protocol ) { diff --git a/maven-artifact/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadata.java b/maven-artifact/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadata.java index e66a84a917..7abdfbbe8a 100644 --- a/maven-artifact/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadata.java +++ b/maven-artifact/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadata.java @@ -26,8 +26,8 @@ import org.apache.maven.artifact.repository.metadata.RepositoryMetadataStoreExce * Contains metadata about an artifact, and methods to retrieve/store it from an artifact repository. * * @author Brett Porter - * @todo merge with artifactmetadatasource - * @todo retrieval exception not appropriate for store + * TODO merge with artifactmetadatasource + * TODO retrieval exception not appropriate for store */ public interface ArtifactMetadata { @@ -64,7 +64,7 @@ public interface ArtifactMetadata * Merge a new metadata set into this piece of metadata. * * @param metadata the new metadata - * @todo this should only be needed on the repository metadata + * TODO this should only be needed on the repository metadata */ void merge( ArtifactMetadata metadata ); @@ -73,7 +73,7 @@ public interface ArtifactMetadata * * @param localRepository the local repository * @param remoteRepository the remote repository it came from - * @todo this should only be needed on the repository metadata + * TODO this should only be needed on the repository metadata */ void storeInLocalRepository( ArtifactRepository localRepository, ArtifactRepository remoteRepository ) diff --git a/maven-artifact/src/test/java/org/apache/maven/artifact/versioning/VersionRangeTest.java b/maven-artifact/src/test/java/org/apache/maven/artifact/versioning/VersionRangeTest.java index 14b16cbaea..dc8d3d57ae 100644 --- a/maven-artifact/src/test/java/org/apache/maven/artifact/versioning/VersionRangeTest.java +++ b/maven-artifact/src/test/java/org/apache/maven/artifact/versioning/VersionRangeTest.java @@ -178,7 +178,7 @@ public class VersionRangeTest VersionRange range1 = VersionRange.createFromVersionSpec( "1.0" ); VersionRange range2 = VersionRange.createFromVersionSpec( "1.1" ); VersionRange mergedRange = range1.restrict( range2 ); - // TODO: current policy is to retain the original version - is this correct, do we need strategies or is that handled elsewhere? + // TODO current policy is to retain the original version - is this correct, do we need strategies or is that handled elsewhere? // assertEquals( CHECK_VERSION_RECOMMENDATION, "1.1", mergedRange.getRecommendedVersion().toString() ); assertEquals( CHECK_VERSION_RECOMMENDATION, "1.0", mergedRange.getRecommendedVersion().toString() ); List restrictions = mergedRange.getRestrictions(); @@ -199,7 +199,7 @@ public class VersionRangeTest assertNull( CHECK_UPPER_BOUND, restriction.getUpperBound() ); assertFalse( CHECK_UPPER_BOUND_INCLUSIVE, restriction.isUpperBoundInclusive() ); - // TODO: test reversed restrictions on all below + // TODO test reversed restrictions on all below range1 = VersionRange.createFromVersionSpec( "[1.0,)" ); range2 = VersionRange.createFromVersionSpec( "1.1" ); mergedRange = range1.restrict( range2 ); diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java b/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java index 7051e3bf55..4460a07c3e 100644 --- a/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java +++ b/maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java @@ -49,8 +49,6 @@ public enum ArtifactScopeEnum /** * Helper method to simplify null processing - * - * @return */ public static final ArtifactScopeEnum checkScope( ArtifactScopeEnum scope ) { diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/manager/DefaultWagonManager.java b/maven-compat/src/main/java/org/apache/maven/artifact/manager/DefaultWagonManager.java index 29876e2480..fe89d1e2d6 100644 --- a/maven-compat/src/main/java/org/apache/maven/artifact/manager/DefaultWagonManager.java +++ b/maven-compat/src/main/java/org/apache/maven/artifact/manager/DefaultWagonManager.java @@ -166,7 +166,7 @@ public class DefaultWagonManager String id = mirror.getId(); if ( id == null ) { - // TODO: this should be illegal in settings.xml + // TODO this should be illegal in settings.xml id = repository.getId(); } diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/DefaultRepositoryMetadataManager.java b/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/DefaultRepositoryMetadataManager.java index d01a290bd4..28ba94df6b 100644 --- a/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/DefaultRepositoryMetadataManager.java +++ b/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/DefaultRepositoryMetadataManager.java @@ -165,7 +165,7 @@ public class DefaultRepositoryMetadataManager } } - // TODO: should this be inside the above check? + // TODO should this be inside the above check? // touch file so that this is not checked again until interval has passed if ( file.exists() ) { @@ -196,9 +196,9 @@ public class DefaultRepositoryMetadataManager ArtifactRepository localRepository ) throws RepositoryMetadataStoreException { - // TODO: currently this is first wins, but really we should take the latest by comparing either the + // TODO currently this is first wins, but really we should take the latest by comparing either the // snapshot timestamp, or some other timestamp later encoded into the metadata. - // TODO: this needs to be repeated here so the merging doesn't interfere with the written metadata + // TODO this needs to be repeated here so the merging doesn't interfere with the written metadata // - we'd be much better having a pristine input, and an ongoing metadata for merging instead Map previousMetadata = new HashMap<>(); @@ -227,7 +227,7 @@ public class DefaultRepositoryMetadataManager ArtifactRepository selected, ArtifactRepository localRepository ) throws RepositoryMetadataStoreException { - // TODO: this could be a lot nicer... should really be in the snapshot transformation? + // TODO this could be a lot nicer... should really be in the snapshot transformation? if ( metadata.isSnapshot() ) { Metadata prevMetadata = metadata.getMetadata(); @@ -312,7 +312,7 @@ public class DefaultRepositoryMetadataManager } /** - * @todo share with DefaultPluginMappingManager. + * TODO share with DefaultPluginMappingManager. */ protected Metadata readMetadata( File mappingFile ) throws RepositoryMetadataReadException diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java b/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java index 359ab2ce4c..5120199276 100644 --- a/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java +++ b/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java @@ -26,7 +26,7 @@ import org.apache.maven.artifact.repository.ArtifactRepository; * Metadata for the artifact version directory of the repository. * * @author Brett Porter - * @todo split instantiation (versioning, plugin mappings) from definition + * TODO split instantiation (versioning, plugin mappings) from definition */ public class SnapshotArtifactRepositoryMetadata extends AbstractRepositoryMetadata diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DebugResolutionListener.java b/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DebugResolutionListener.java index bd1ed9ae80..01aa80fcaf 100644 --- a/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DebugResolutionListener.java +++ b/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DebugResolutionListener.java @@ -85,7 +85,7 @@ public class DebugResolutionListener logger.debug( indent + artifact + " (not setting artifactScope to: " + ignoredScope + "; local artifactScope " + artifact.getScope() + " wins)" ); - // TODO: better way than static? this might hide messages in a reactor + // TODO better way than static? this might hide messages in a reactor if ( !ignoredArtifacts.contains( artifact ) ) { logger.warn( "\n\tArtifact " + artifact + " retains local artifactScope '" + artifact.getScope() diff --git a/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactResolver.java b/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactResolver.java index 6a5f330734..b78846b106 100644 --- a/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactResolver.java +++ b/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactResolver.java @@ -376,7 +376,7 @@ public class DefaultArtifactResolver ArtifactFilter resolutionFilter = request.getResolutionFilter(); RepositorySystemSession session = getSession( request.getLocalRepository() ); - // TODO: hack because metadata isn't generated in m2e correctly and i want to run the maven i have in the + // TODO hack because metadata isn't generated in m2e correctly and i want to run the maven i have in the // workspace if ( source == null ) { diff --git a/maven-compat/src/main/java/org/apache/maven/project/MavenProjectBuilder.java b/maven-compat/src/main/java/org/apache/maven/project/MavenProjectBuilder.java index 816b4a9eb0..df97948149 100644 --- a/maven-compat/src/main/java/org/apache/maven/project/MavenProjectBuilder.java +++ b/maven-compat/src/main/java/org/apache/maven/project/MavenProjectBuilder.java @@ -54,7 +54,7 @@ public interface MavenProjectBuilder ArtifactRepository localRepository, boolean allowStubModel ) throws ProjectBuildingException; - // TODO: this is only to provide a project for plugins that don't need a project to execute but need some + // TODO this is only to provide a project for plugins that don't need a project to execute but need some // of the values from a MavenProject. Ideally this should be something internal and nothing outside Maven // would ever need this so it should not be exposed in a public API MavenProject buildStandaloneSuperProject( ProjectBuilderConfiguration configuration ) diff --git a/maven-compat/src/main/java/org/apache/maven/project/inheritance/DefaultModelInheritanceAssembler.java b/maven-compat/src/main/java/org/apache/maven/project/inheritance/DefaultModelInheritanceAssembler.java index eab3660105..07e9473b83 100644 --- a/maven-compat/src/main/java/org/apache/maven/project/inheritance/DefaultModelInheritanceAssembler.java +++ b/maven-compat/src/main/java/org/apache/maven/project/inheritance/DefaultModelInheritanceAssembler.java @@ -51,7 +51,7 @@ import org.codehaus.plexus.util.xml.Xpp3Dom; public class DefaultModelInheritanceAssembler implements ModelInheritanceAssembler { - // TODO: Remove this! + // TODO Remove this! @SuppressWarnings( "unchecked" ) public void assembleBuildInheritance( Build childBuild, Build parentBuild, boolean handleAsInheritance ) { @@ -303,7 +303,7 @@ public class DefaultModelInheritanceAssembler child.setProperties( props ); } - // TODO: Remove this! + // TODO Remove this! @SuppressWarnings( "unchecked" ) private void assembleDependencyManagementInheritance( Model child, Model parent ) { @@ -523,7 +523,7 @@ public class DefaultModelInheritanceAssembler } - // TODO: Remove this! + // TODO Remove this! @SuppressWarnings( "unchecked" ) private void assembleDependencyInheritance( Model child, Model parent ) { @@ -653,7 +653,7 @@ public class DefaultModelInheritanceAssembler return repository; } - // TODO: This should eventually be migrated to DefaultPathTranslator. + // TODO This should eventually be migrated to DefaultPathTranslator. protected String appendPath( String parentPath, String childPath, String pathAdjustment, boolean appendPaths ) { String uncleanPath = parentPath; @@ -689,7 +689,7 @@ public class DefaultModelInheritanceAssembler return cleanedPath + resolvePath( uncleanPath ); } - // TODO: Move this to plexus-utils' PathTool. + // TODO Move this to plexus-utils' PathTool. private static String resolvePath( String uncleanPath ) { LinkedList pathElements = new LinkedList<>(); diff --git a/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java b/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java index c40b16484f..b3e94fcaba 100644 --- a/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java +++ b/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java @@ -58,7 +58,7 @@ import java.util.Properties; * Use a regular expression search to find and resolve expressions within the POM. * * @author jdcasey Created on Feb 3, 2005 - * @todo Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans. + * TODO Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans. */ @Deprecated public abstract class AbstractStringBasedModelInterpolator @@ -104,7 +104,7 @@ public abstract class AbstractStringBasedModelInterpolator } /** - * @todo: Remove the throws clause. + * TODO Remove the throws clause. * @throws IOException This exception is not thrown any more, and needs to be removed. */ protected AbstractStringBasedModelInterpolator() @@ -190,8 +190,6 @@ public abstract class AbstractStringBasedModelInterpolator * with the value, and continue to find other expressions. *
  • If the value is null, get it from the model properties.
    • *
  • - * @param overrideContext - * @param outputDebugMessages */ public String interpolate( String src, Model model, diff --git a/maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java b/maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java index 4e251aee09..78990ea76e 100644 --- a/maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java +++ b/maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java @@ -30,7 +30,7 @@ import org.codehaus.plexus.interpolation.RegexBasedInterpolator; * Use a regular expression search to find and resolve expressions within the POM. * * @author jdcasey Created on Feb 3, 2005 - * @todo Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans. + * TODO Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans. */ @Deprecated public class RegexBasedModelInterpolator diff --git a/maven-compat/src/main/java/org/apache/maven/repository/MetadataGraph.java b/maven-compat/src/main/java/org/apache/maven/repository/MetadataGraph.java index e994856c17..3568ff0260 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/MetadataGraph.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/MetadataGraph.java @@ -57,7 +57,6 @@ public class MetadataGraph * find a node by the GAV (metadata) * * @param md - * @return */ public MetadataGraphNode findNode( MavenArtifactMetadata md ) { @@ -76,8 +75,6 @@ public class MetadataGraph /** * getter - * - * @return */ public MetadataGraphNode getEntry() { @@ -86,8 +83,6 @@ public class MetadataGraph /** * getter - * - * @return */ public Collection getNodes() { diff --git a/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionRequest.java b/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionRequest.java index 7593351755..75d9ddc264 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionRequest.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionRequest.java @@ -123,7 +123,7 @@ public class MetadataResolutionRequest } /** - * @deprecated instead use {@link #setRemoteRepositories()} + * @deprecated instead use {@link #setRemoteRepositories(List)} */ @Deprecated public MetadataResolutionRequest setRemoteRepostories( List remoteRepostories ) diff --git a/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java b/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java index 906d0f69e1..0071ea44e5 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java @@ -161,7 +161,7 @@ public class MetadataResolutionResult } /** - * @TODO this needs to accept a {@link OverConstrainedVersionException} as returned by + * TODO this needs to accept a {@link OverConstrainedVersionException} as returned by * {@link #getVersionRangeViolation(int)} but it's not used like that in * {@link DefaultLegacyArtifactCollector} */ diff --git a/maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java b/maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java index b8835b5143..8dd6b368c8 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java @@ -56,9 +56,9 @@ import org.codehaus.plexus.util.FileUtils; import org.eclipse.aether.ConfigurationProperties; import org.eclipse.aether.util.ConfigUtils; -//TODO: remove the update check manager -//TODO: separate into retriever and publisher -//TODO: remove hardcoding of checksum logic +//TODO remove the update check manager +//TODO separate into retriever and publisher +//TODO remove hardcoding of checksum logic @Component( role = WagonManager.class ) public class DefaultWagonManager implements WagonManager @@ -378,7 +378,7 @@ public class DefaultWagonManager ChecksumObserver sha1ChecksumObserver = null; try { - // TODO: configure on repository + // TODO configure on repository int i = 0; md5ChecksumObserver = addChecksumObserver( wagon, CHECKSUM_ALGORITHMS[i++] ); @@ -594,7 +594,7 @@ public class DefaultWagonManager Map sums = new HashMap<>( 2 ); - // TODO: configure these on the repository + // TODO configure these on the repository for ( int i = 0; i < CHECKSUM_IDS.length; i++ ) { checksums.put( CHECKSUM_IDS[i], addChecksumObserver( wagon, CHECKSUM_ALGORITHMS[i] ) ); @@ -628,7 +628,7 @@ public class DefaultWagonManager // We do this in here so we can checksum the artifact metadata too, otherwise it could be metadata itself for ( String extension : checksums.keySet() ) { - // TODO: shouldn't need a file intermediatary - improve wagon to take a stream + // TODO shouldn't need a file intermediatary - improve wagon to take a stream File temp = File.createTempFile( "maven-artifact", null ); temp.deleteOnExit(); FileUtils.fileWrite( temp.getAbsolutePath(), "UTF-8", sums.get( extension ) ); diff --git a/maven-compat/src/main/java/org/apache/maven/repository/legacy/repository/DefaultArtifactRepositoryFactory.java b/maven-compat/src/main/java/org/apache/maven/repository/legacy/repository/DefaultArtifactRepositoryFactory.java index 4bc911673d..fc6b441286 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/legacy/repository/DefaultArtifactRepositoryFactory.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/legacy/repository/DefaultArtifactRepositoryFactory.java @@ -37,7 +37,7 @@ import org.codehaus.plexus.component.annotations.Requirement; public class DefaultArtifactRepositoryFactory implements ArtifactRepositoryFactory { - // TODO: use settings? + // TODO use settings? private String globalUpdatePolicy; private String globalChecksumPolicy; diff --git a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/DefaultLegacyArtifactCollector.java b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/DefaultLegacyArtifactCollector.java index 88168f1f2d..c3603a660f 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/DefaultLegacyArtifactCollector.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/DefaultLegacyArtifactCollector.java @@ -249,7 +249,7 @@ public class DefaultLegacyArtifactCollector Object key = node.getKey(); - // TODO: Does this check need to happen here? Had to add the same call + // TODO Does this check need to happen here? Had to add the same call // below when we iterate on child nodes -- will that suffice? if ( managedVersions.containsKey( key ) ) { @@ -272,11 +272,11 @@ public class DefaultLegacyArtifactCollector if ( ( previousRange != null ) && ( currentRange != null ) ) { - // TODO: shouldn't need to double up on this work, only done for simplicity of handling + // TODO shouldn't need to double up on this work, only done for simplicity of handling // recommended // version but the restriction is identical VersionRange newRange = previousRange.restrict( currentRange ); - // TODO: ick. this forces the OCE that should have come from the previous call. It is still + // TODO ick. this forces the OCE that should have come from the previous call. It is still // correct if ( newRange.isSelectedVersionKnown( previous.getArtifact() ) ) { @@ -363,7 +363,7 @@ public class DefaultLegacyArtifactCollector if ( resolved == null ) { - // TODO: add better exception that can detail the two conflicting artifacts + // TODO add better exception that can detail the two conflicting artifacts ArtifactResolutionException are = new ArtifactResolutionException( "Cannot resolve artifact version conflict between " + previous.getArtifact().getVersion() + " and " @@ -375,14 +375,14 @@ public class DefaultLegacyArtifactCollector if ( ( resolved != previous ) && ( resolved != node ) ) { - // TODO: add better exception + // TODO add better exception result.addVersionRangeViolation( new ArtifactResolutionException( "Conflict resolver returned unknown resolution node: ", resolved.getArtifact() ) ); } - // TODO: should this be part of mediation? + // TODO should this be part of mediation? // previous one is more dominant ResolutionNode nearest; ResolutionNode farthest; @@ -501,7 +501,7 @@ public class DefaultLegacyArtifactCollector if ( artifact.getVersion() == null ) { // set the recommended version - // TODO: maybe its better to just pass the range through to retrieval and use a + // TODO maybe its better to just pass the range through to retrieval and use a // transformation? ArtifactVersion version; if ( !artifact.isSelectedVersionKnown() ) diff --git a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java index 66716d1eae..9192b1857a 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java @@ -32,7 +32,7 @@ import org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable; * A conflict resolver factory that obtains instances from a plexus container. * * @author Mark Hobson - * @todo you don't need the container in here with the active maps (jvz). + * TODO you don't need the container in here with the active maps (jvz). * @since 3.0 */ @Component( role = ConflictResolverFactory.class ) diff --git a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolver.java b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolver.java index 1879a813fd..e5bf55801e 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolver.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolver.java @@ -54,7 +54,7 @@ public class NewestConflictResolver } catch ( OverConstrainedVersionException exception ) { - // TODO: log message or throw exception? + // TODO log message or throw exception? return null; } diff --git a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolver.java b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolver.java index 5c5c12d6f6..d5e880c86a 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolver.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolver.java @@ -54,7 +54,7 @@ public class OldestConflictResolver } catch ( OverConstrainedVersionException exception ) { - // TODO: log message or throw exception? + // TODO log message or throw exception? return null; } diff --git a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java index 3a5c7c6aa2..1ce54580b9 100644 --- a/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java +++ b/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java @@ -42,7 +42,7 @@ import org.codehaus.plexus.logging.AbstractLogEnabled; * Describes a version transformation during artifact resolution. * * @author Brett Porter - * @todo try and refactor to remove abstract methods - not particular happy about current design + * TODO try and refactor to remove abstract methods - not particular happy about current design */ public abstract class AbstractVersionTransformation extends AbstractLogEnabled @@ -105,8 +105,8 @@ public abstract class AbstractVersionTransformation version = artifact.getBaseVersion(); } - // TODO: also do this logging for other metadata? - // TODO: figure out way to avoid duplicated message + // TODO also do this logging for other metadata? + // TODO figure out way to avoid duplicated message if ( getLogger().isDebugEnabled() ) { if ( !version.equals( artifact.getBaseVersion() ) ) diff --git a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/DefaultArtifactCollectorTest.java b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/DefaultArtifactCollectorTest.java index 39084fecfe..391ec0f6b8 100644 --- a/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/DefaultArtifactCollectorTest.java +++ b/maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/DefaultArtifactCollectorTest.java @@ -166,7 +166,7 @@ public class DefaultArtifactCollectorTest public void disabledtestResolveCorrectDependenciesWhenDifferentDependenciesOnNewest() throws ArtifactResolutionException, InvalidVersionSpecificationException { - // TODO: use newest conflict resolver + // TODO use newest conflict resolver ArtifactSpec a = createArtifactSpec( "a", "1.0" ); ArtifactSpec b = a.addDependency( "b", "1.0" ); ArtifactSpec c2 = b.addDependency( "c", "2.0" ); @@ -185,7 +185,7 @@ public class DefaultArtifactCollectorTest public void disabledtestResolveCorrectDependenciesWhenDifferentDependenciesOnNewestVersionReplaced() throws ArtifactResolutionException, InvalidVersionSpecificationException { - // TODO: use newest conflict resolver + // TODO use newest conflict resolver ArtifactSpec a = createArtifactSpec( "a", "1.0" ); ArtifactSpec b1 = a.addDependency( "b", "1.0" ); ArtifactSpec c = a.addDependency( "c", "1.0" ); diff --git a/maven-core/src/main/java/org/apache/maven/AbstractMavenLifecycleParticipant.java b/maven-core/src/main/java/org/apache/maven/AbstractMavenLifecycleParticipant.java index 01247aec18..faddef4575 100644 --- a/maven-core/src/main/java/org/apache/maven/AbstractMavenLifecycleParticipant.java +++ b/maven-core/src/main/java/org/apache/maven/AbstractMavenLifecycleParticipant.java @@ -53,7 +53,7 @@ public abstract class AbstractMavenLifecycleParticipant * activate profiles and perform similar tasks that affect MavenProject * instance construction. */ - // TODO: This is too early for build extensions, so maybe just remove it? + // TODO This is too early for build extensions, so maybe just remove it? public void afterSessionStart( MavenSession session ) throws MavenExecutionException { diff --git a/maven-core/src/main/java/org/apache/maven/DefaultArtifactFilterManager.java b/maven-core/src/main/java/org/apache/maven/DefaultArtifactFilterManager.java index 503dcdb313..a746846a8b 100644 --- a/maven-core/src/main/java/org/apache/maven/DefaultArtifactFilterManager.java +++ b/maven-core/src/main/java/org/apache/maven/DefaultArtifactFilterManager.java @@ -85,7 +85,7 @@ public class DefaultArtifactFilterManager /** * Returns the artifact filter for the standard core artifacts. * - * @see org.apache.maven.ArtifactFilterManager#getExtensionDependencyFilter() + * @see org.apache.maven.ArtifactFilterManager#getCoreArtifactFilter() */ public ArtifactFilter getCoreArtifactFilter() { diff --git a/maven-core/src/main/java/org/apache/maven/artifact/DependencyResolutionRequiredException.java b/maven-core/src/main/java/org/apache/maven/artifact/DependencyResolutionRequiredException.java index b54ba07081..99794231e8 100644 --- a/maven-core/src/main/java/org/apache/maven/artifact/DependencyResolutionRequiredException.java +++ b/maven-core/src/main/java/org/apache/maven/artifact/DependencyResolutionRequiredException.java @@ -23,7 +23,7 @@ package org.apache.maven.artifact; * Exception that occurs when an artifact file is used, but has not been resolved. * * @author Brett Porter - * @todo it may be better for artifact.getFile() to throw it - perhaps it is a runtime exception? + * TODO it may be better for artifact.getFile() to throw it - perhaps it is a runtime exception? */ public class DependencyResolutionRequiredException extends Exception diff --git a/maven-core/src/main/java/org/apache/maven/artifact/repository/MavenArtifactRepository.java b/maven-core/src/main/java/org/apache/maven/artifact/repository/MavenArtifactRepository.java index 38ae6bb76b..9765c73365 100644 --- a/maven-core/src/main/java/org/apache/maven/artifact/repository/MavenArtifactRepository.java +++ b/maven-core/src/main/java/org/apache/maven/artifact/repository/MavenArtifactRepository.java @@ -28,7 +28,7 @@ import org.apache.maven.artifact.metadata.ArtifactMetadata; import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout; import org.apache.maven.repository.Proxy; -//TODO: completely separate local and remote artifact repositories +//TODO completely separate local and remote artifact repositories public class MavenArtifactRepository implements ArtifactRepository { @@ -234,7 +234,7 @@ public class MavenArtifactRepository * * @param url the repository URL * @return the basedir of the repository - * @todo need to URL decode for spaces? + * TODO need to URL decode for spaces? */ private String basedir( String url ) { diff --git a/maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/AbstractRepositoryMetadata.java b/maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/AbstractRepositoryMetadata.java index 37e69e5bea..46c41b94e7 100644 --- a/maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/AbstractRepositoryMetadata.java +++ b/maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/AbstractRepositoryMetadata.java @@ -181,7 +181,7 @@ public abstract class AbstractRepositoryMetadata public void merge( org.apache.maven.repository.legacy.metadata.ArtifactMetadata metadata ) { - // TODO: not sure that it should assume this, maybe the calls to addMetadata should pre-merge, then artifact + // TODO not sure that it should assume this, maybe the calls to addMetadata should pre-merge, then artifact // replaces? AbstractRepositoryMetadata repoMetadata = (AbstractRepositoryMetadata) metadata; this.metadata.merge( repoMetadata.getMetadata() ); @@ -189,7 +189,7 @@ public abstract class AbstractRepositoryMetadata public void merge( ArtifactMetadata metadata ) { - // TODO: not sure that it should assume this, maybe the calls to addMetadata should pre-merge, then artifact + // TODO not sure that it should assume this, maybe the calls to addMetadata should pre-merge, then artifact // replaces? AbstractRepositoryMetadata repoMetadata = (AbstractRepositoryMetadata) metadata; this.metadata.merge( repoMetadata.getMetadata() ); diff --git a/maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java b/maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java index 22e3ade831..d7fe50b430 100644 --- a/maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java +++ b/maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java @@ -26,7 +26,7 @@ import org.apache.maven.artifact.repository.ArtifactRepositoryPolicy; * Describes repository directory metadata. * * @author Brett Porter - * @todo not happy about the store method - they use "this" + * TODO not happy about the store method - they use "this" */ public interface RepositoryMetadata extends org.apache.maven.artifact.metadata.ArtifactMetadata diff --git a/maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java b/maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java index 2bad1a74af..b780f50af7 100644 --- a/maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java +++ b/maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java @@ -36,7 +36,7 @@ import org.apache.maven.artifact.versioning.OverConstrainedVersionException; * - network/transfer errors - file system errors: permissions * * @author Jason van Zyl - * @TODO carlos: all these possible has*Exceptions and get*Exceptions methods make the clients too + * TODO carlos: all these possible has*Exceptions and get*Exceptions methods make the clients too * complex requiring a long list of checks, need to create a parent/interface/encapsulation * for the types of exceptions */ @@ -173,7 +173,7 @@ public class ArtifactResolutionResult } /** - * @TODO this needs to accept a {@link OverConstrainedVersionException} as returned by + * TODO this needs to accept a {@link OverConstrainedVersionException} as returned by * {@link #getVersionRangeViolation(int)} but it's not used like that in * {@link DefaultLegacyArtifactCollector} */ diff --git a/maven-core/src/main/java/org/apache/maven/artifact/resolver/ResolutionNode.java b/maven-core/src/main/java/org/apache/maven/artifact/resolver/ResolutionNode.java index 5651641232..3b64eaf4d9 100644 --- a/maven-core/src/main/java/org/apache/maven/artifact/resolver/ResolutionNode.java +++ b/maven-core/src/main/java/org/apache/maven/artifact/resolver/ResolutionNode.java @@ -198,7 +198,7 @@ public class ResolutionNode { active = true; - // TODO: if it was null, we really need to go find them now... or is this taken care of by the ordering? + // TODO if it was null, we really need to go find them now... or is this taken care of by the ordering? if ( children != null ) { for ( ResolutionNode node : children ) diff --git a/maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/ExcludesArtifactFilter.java b/maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/ExcludesArtifactFilter.java index b6ef02e5d6..e448af4dde 100644 --- a/maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/ExcludesArtifactFilter.java +++ b/maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/ExcludesArtifactFilter.java @@ -27,7 +27,7 @@ import org.apache.maven.artifact.Artifact; * Filter to exclude from a list of artifact patterns. * * @author Brett Porter - * @todo I think this is equiv. to exclusion set filter in maven-core + * TODO I think this is equiv. to exclusion set filter in maven-core */ public class ExcludesArtifactFilter extends IncludesArtifactFilter diff --git a/maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/IncludesArtifactFilter.java b/maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/IncludesArtifactFilter.java index 6ac888433f..7a3b6c7cbe 100644 --- a/maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/IncludesArtifactFilter.java +++ b/maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/IncludesArtifactFilter.java @@ -49,7 +49,7 @@ public class IncludesArtifactFilter boolean matched = false; for ( Iterator i = patterns.iterator(); i.hasNext() & !matched; ) { - // TODO: what about wildcards? Just specifying groups? versions? + // TODO what about wildcards? Just specifying groups? versions? if ( id.equals( i.next() ) ) { matched = true; diff --git a/maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java b/maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java index d67061f948..089a7db264 100644 --- a/maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java +++ b/maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java @@ -1088,7 +1088,7 @@ public class DefaultMavenExecutionRequest return pluginArtifactRepositories; } - // TODO: this does not belong here. + // TODO this does not belong here. @Override public ProjectBuildingRequest getProjectBuildingRequest() { diff --git a/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java b/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java index 53f84c5092..d006a434c5 100644 --- a/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java +++ b/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java @@ -356,15 +356,15 @@ public interface MavenExecutionRequest MavenExecutionRequest setUserToolchainsFile( File userToolchainsFile ); /** - * - * + * + * * @return the global toolchains file * @since 3.3.0 */ File getGlobalToolchainsFile(); /** - * + * * @param globalToolchainsFile the global toolchains file * @return this request * @since 3.3.0 @@ -388,29 +388,31 @@ public interface MavenExecutionRequest MavenExecutionRequest setUseLegacyLocalRepository( boolean useLegacyLocalRepository ); /** - * Controls the {@link Builder} used by Maven by specification of the builder's id. + * Controls the {@link org.apache.maven.lifecycle.internal.builder.Builder} used by Maven by specification + * of the builder's id. * * @since 3.2.0 */ MavenExecutionRequest setBuilderId( String builderId ); /** - * Controls the {@link Builder} used by Maven by specification of the builders id. + * Controls the {@link org.apache.maven.lifecycle.internal.builder.Builder} used by Maven by specification + * of the builders id. * * @since 3.2.0 */ String getBuilderId(); /** - * - * @param toolchains all toolchains grouped by type - * @return this request + * + * @param toolchains all toolchains grouped by type + * @return this request * @since 3.3.0 */ MavenExecutionRequest setToolchains( Map> toolchains ); - + /** - * + * * @return all toolchains grouped by type, never {@code null} * @since 3.3.0 */ @@ -428,9 +430,9 @@ public interface MavenExecutionRequest /** * @since 3.3.0 - */ + */ MavenExecutionRequest setEventSpyDispatcher( EventSpyDispatcher eventSpyDispatcher ); - + /** * @since 3.3.0 */ diff --git a/maven-core/src/main/java/org/apache/maven/execution/scope/WeakMojoExecutionListener.java b/maven-core/src/main/java/org/apache/maven/execution/scope/WeakMojoExecutionListener.java index 94e7c10458..102bc1d70e 100644 --- a/maven-core/src/main/java/org/apache/maven/execution/scope/WeakMojoExecutionListener.java +++ b/maven-core/src/main/java/org/apache/maven/execution/scope/WeakMojoExecutionListener.java @@ -25,8 +25,9 @@ import org.apache.maven.plugin.MojoExecutionException; /** * Extension point that allows build extensions observe and possibly veto mojo executions. *

    - * Unlike {@link MojoExecutionListener}, this extension point does not trigger instantiation of the component, hence - * "weak" class name prefix. Only applies to mojo execution scoped components. + * Unlike {@link org.apache.maven.execution.MojoExecutionListener}, this extension point does not + * trigger instantiation of the component, hence "weak" class name prefix. Only applies to mojo execution + * scoped components. * * @see org.apache.maven.execution.MojoExecutionListener * @since 3.1.2 diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java b/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java index 6f994b3d3f..dae18948ac 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java @@ -97,8 +97,8 @@ public class DefaultLifecycleExecutor // fully populated Plugin objects, including executions with goals and default configuration taken // from the plugin.xml inside a plugin. // - // TODO: This whole method could probably removed by injecting lifeCyclePluginAnalyzer straight into client site. - // TODO: But for some reason the whole plexus appcontext refuses to start when I try this. + // TODO This whole method could probably removed by injecting lifeCyclePluginAnalyzer straight into client site. + // TODO But for some reason the whole plexus appcontext refuses to start when I try this. public Set getPluginsBoundByDefaultToAllLifecycles( String packaging ) { diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java b/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java index 48cd0c5c45..8186a39fc2 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java @@ -40,7 +40,7 @@ import java.util.Set; * @author Jason van Zyl * @author Kristian Rosenvold */ -// TODO: The configuration for the lifecycle needs to be externalized so that I can use the annotations properly for the +// TODO The configuration for the lifecycle needs to be externalized so that I can use the annotations properly for the // wiring and reference and external source for the lifecycle configuration. @Component( role = DefaultLifecycles.class ) public class DefaultLifecycles diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/MavenExecutionPlan.java b/maven-core/src/main/java/org/apache/maven/lifecycle/MavenExecutionPlan.java index 7dacb8ed96..e7b1a7f91a 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/MavenExecutionPlan.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/MavenExecutionPlan.java @@ -34,13 +34,13 @@ import org.apache.maven.model.Plugin; import org.apache.maven.plugin.MojoExecution; import org.apache.maven.plugin.descriptor.MojoDescriptor; -//TODO: lifecycles being executed -//TODO: what runs in each phase -//TODO: plugins that need downloading -//TODO: project dependencies that need downloading -//TODO: unfortunately the plugins need to be downloaded in order to get the plugin.xml file. need to externalize this +//TODO lifecycles being executed +//TODO what runs in each phase +//TODO plugins that need downloading +//TODO project dependencies that need downloading +//TODO unfortunately the plugins need to be downloaded in order to get the plugin.xml file. need to externalize this // from the plugin archive. -//TODO: this will be the class that people get in IDEs to modify +//TODO this will be the class that people get in IDEs to modify public class MavenExecutionPlan implements Iterable diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecycleExecutionPlanCalculator.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecycleExecutionPlanCalculator.java index 26008811a2..46aff9e8e5 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecycleExecutionPlanCalculator.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecycleExecutionPlanCalculator.java @@ -525,8 +525,8 @@ public class DefaultLifecycleExecutionPlanCalculator } // org.apache.maven.plugins:maven-remote-resources-plugin:1.0:process - // TODO: take repo mans into account as one may be aggregating prefixes of many - // TODO: collect at the root of the repository, read the one at the root, and fetch remote if something is missing + // TODO take repo mans into account as one may be aggregating prefixes of many + // TODO collect at the root of the repository, read the one at the root, and fetch remote if something is missing // or the user forces the issue private List calculateForkedGoal( MojoExecution mojoExecution, MavenSession session, diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DependencyContext.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DependencyContext.java index 18fae7a951..0e4a708feb 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DependencyContext.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DependencyContext.java @@ -35,7 +35,7 @@ import java.util.TreeSet; *

    * NOTE: This class is not part of any public api and can be changed or deleted without prior notice. */ -// TODO: From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice +// TODO From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice public class DependencyContext { diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/GoalTask.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/GoalTask.java index 89e456b1b6..f1664034a4 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/GoalTask.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/GoalTask.java @@ -22,7 +22,7 @@ package org.apache.maven.lifecycle.internal; /** * A task that is a goal *

    - * TODO: From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice + * TODO From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice * * @since 3.0 * @author Benjamin Bentmann diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoDescriptorCreator.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoDescriptorCreator.java index e6b09ced6f..a19467feaa 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoDescriptorCreator.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoDescriptorCreator.java @@ -239,8 +239,8 @@ public class MojoDescriptorCreator session.getRepositorySession() ); } - // TODO: take repo mans into account as one may be aggregating prefixes of many - // TODO: collect at the root of the repository, read the one at the root, and fetch remote if something is missing + // TODO take repo mans into account as one may be aggregating prefixes of many + // TODO collect at the root of the repository, read the one at the root, and fetch remote if something is missing // or the user forces the issue public Plugin findPluginForPrefix( String prefix, MavenSession session ) diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectBuildList.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectBuildList.java index 427f449a9f..2d7371ba7e 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectBuildList.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectBuildList.java @@ -51,7 +51,7 @@ public class ProjectBuildList this.items = Collections.unmodifiableList( items ); } - // TODO: Optimize; or maybe just rewrite the whole way aggregating mojos are being run. + // TODO Optimize; or maybe just rewrite the whole way aggregating mojos are being run. /** * Returns aProjectBuildList that contains only items for the specified taskSegment * @param taskSegment the requested tasksegment diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectIndex.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectIndex.java index 13539b41d2..aa56d57184 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectIndex.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectIndex.java @@ -35,7 +35,7 @@ import java.util.Map; *

    * NOTE: This class is not part of any public api and can be changed or deleted without prior notice. */ -// Todo: Kristian wonders if this class really is necessary and if it overlaps other concepts. +// TODO Kristian wonders if this class really is necessary and if it overlaps other concepts. public final class ProjectIndex { diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/TaskSegment.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/TaskSegment.java index 492bcda167..16eb76a3c8 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/TaskSegment.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/TaskSegment.java @@ -69,5 +69,5 @@ public final class TaskSegment return aggregating; } - // TODO: Consider throwing UnsupportedSomething on hashCode/equals + // TODO Consider throwing UnsupportedSomething on hashCode/equals } diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/BuilderCommon.java b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/BuilderCommon.java index 34fb323ecc..f770670be4 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/BuilderCommon.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/BuilderCommon.java @@ -188,7 +188,7 @@ public class BuilderCommon } } - // Todo: I'm really wondering where this method belongs; smells like it should be on MavenProject, but for some + // TODO I'm really wondering where this method belongs; smells like it should be on MavenProject, but for some // reason it isn't ? This localization is kind-of a code smell. public static String getKey( MavenProject project ) diff --git a/maven-core/src/main/java/org/apache/maven/lifecycle/mapping/Lifecycle.java b/maven-core/src/main/java/org/apache/maven/lifecycle/mapping/Lifecycle.java index c14cf94fa9..27f612f3ce 100644 --- a/maven-core/src/main/java/org/apache/maven/lifecycle/mapping/Lifecycle.java +++ b/maven-core/src/main/java/org/apache/maven/lifecycle/mapping/Lifecycle.java @@ -62,7 +62,7 @@ public class Lifecycle { return this.lifecyclePhases; } - + /** * Method setId * @@ -76,7 +76,7 @@ public class Lifecycle /** * Method setLifecyclePhases * - * @param phases + * @param lifecyclePhases */ public void setLifecyclePhases( Map lifecyclePhases ) { @@ -91,12 +91,12 @@ public class Lifecycle { return null; } - + if ( lphases.isEmpty() ) { return Collections.emptyMap(); } - + Map phases = new LinkedHashMap<>(); for ( Map.Entry e: lphases.entrySet() ) { diff --git a/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java b/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java index 5d7a56c0e9..b4f7a4df23 100644 --- a/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java +++ b/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java @@ -37,8 +37,8 @@ import org.codehaus.plexus.component.annotations.Requirement; import org.eclipse.aether.RepositorySystemSession; import org.eclipse.aether.repository.RemoteRepository; -// TODO: the antrun plugin has its own configurator, the only plugin that does. might need to think about how that works -// TODO: remove the coreArtifactFilterManager +// TODO the antrun plugin has its own configurator, the only plugin that does. might need to think about how that works +// TODO remove the coreArtifactFilterManager @Component( role = BuildPluginManager.class ) public class DefaultBuildPluginManager diff --git a/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java b/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java index a7eeb4e307..984e22ab32 100644 --- a/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java +++ b/maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java @@ -83,7 +83,7 @@ public class PluginParameterExpressionEvaluator private Properties properties; - @Deprecated //TODO: used by the Enforcer plugin + @Deprecated //TODO used by the Enforcer plugin public PluginParameterExpressionEvaluator( MavenSession session, MojoExecution mojoExecution, PathTranslator pathTranslator, Logger logger, MavenProject project, Properties properties ) @@ -228,7 +228,7 @@ public class PluginParameterExpressionEvaluator } catch ( Exception e ) { - // TODO: don't catch exception + // TODO don't catch exception throw new ExpressionEvaluationException( "Error evaluating plugin parameter expression: " + expression, e ); } @@ -268,7 +268,7 @@ public class PluginParameterExpressionEvaluator } catch ( Exception e ) { - // TODO: don't catch exception + // TODO don't catch exception throw new ExpressionEvaluationException( "Error evaluating plugin parameter expression: " + expression, e ); } @@ -300,7 +300,7 @@ public class PluginParameterExpressionEvaluator } catch ( Exception e ) { - // TODO: don't catch exception + // TODO don't catch exception throw new ExpressionEvaluationException( "Error evaluating plugin parameter expression: " + expression, e ); } @@ -357,7 +357,7 @@ public class PluginParameterExpressionEvaluator } catch ( Exception e ) { - // TODO: don't catch exception + // TODO don't catch exception throw new ExpressionEvaluationException( "Error evaluating plugin parameter expression: " + expression, e ); } @@ -412,7 +412,7 @@ public class PluginParameterExpressionEvaluator if ( value instanceof String ) { - // TODO: without #, this could just be an evaluate call... + // TODO without #, this could just be an evaluate call... String val = (String) value; @@ -457,7 +457,7 @@ public class PluginParameterExpressionEvaluator @Override public File alignToBaseDirectory( File file ) { - // TODO: Copied from the DefaultInterpolator. We likely want to resurrect the PathTranslator or at least a + // TODO Copied from the DefaultInterpolator. We likely want to resurrect the PathTranslator or at least a // similar component for re-usage if ( file != null ) { diff --git a/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPluginManager.java b/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPluginManager.java index b87994e22a..72075fd0af 100644 --- a/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPluginManager.java +++ b/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPluginManager.java @@ -124,7 +124,7 @@ public class DefaultMavenPluginManager * PluginId=>ExtensionRealmCache.CacheRecord map MavenProject context value key. The map is used to ensure the same * class realm is used to load build extensions and load mojos for extensions=true plugins. * - * @noreference this is part of internal implementation and may be changed or removed without notice + * @provisional This is part of internal implementation and may be changed or removed without notice * @since 3.3.0 */ public static final String KEY_EXTENSIONS_REALMS = DefaultMavenPluginManager.class.getName() + "/extensionsRealms"; @@ -617,7 +617,7 @@ public class DefaultMavenPluginManager try { - // TODO: could the configuration be passed to lookup and the configurator known to plexus via the descriptor + // TODO could the configuration be passed to lookup and the configurator known to plexus via the descriptor // so that this method could entirely be handled by a plexus lookup? configurator = container.lookup( ComponentConfigurator.class, configuratorId ); diff --git a/maven-core/src/main/java/org/apache/maven/project/DuplicateArtifactAttachmentException.java b/maven-core/src/main/java/org/apache/maven/project/DuplicateArtifactAttachmentException.java index 6121473da3..d263c28471 100644 --- a/maven-core/src/main/java/org/apache/maven/project/DuplicateArtifactAttachmentException.java +++ b/maven-core/src/main/java/org/apache/maven/project/DuplicateArtifactAttachmentException.java @@ -27,7 +27,7 @@ import org.apache.maven.artifact.Artifact; * * @author pgier * @author jdcasey - * @todo Make this a checked exception, and modify the API of MavenProjectHelper. + * TODO Make this a checked exception, and modify the API of MavenProjectHelper. * Currently, this modification would create compatibility problems for existing plugins. */ public class DuplicateArtifactAttachmentException diff --git a/maven-core/src/main/java/org/apache/maven/project/MavenProject.java b/maven-core/src/main/java/org/apache/maven/project/MavenProject.java index 77206bd5fc..cc35a57867 100644 --- a/maven-core/src/main/java/org/apache/maven/project/MavenProject.java +++ b/maven-core/src/main/java/org/apache/maven/project/MavenProject.java @@ -221,7 +221,7 @@ public class MavenProject this.artifact = artifact; } - // @todo I would like to get rid of this. jvz. + // TODO I would like to get rid of this. jvz. public Model getModel() { return model; @@ -352,7 +352,7 @@ public class MavenProject { if ( a.getArtifactHandler().isAddedToClasspath() ) { - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this if ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_PROVIDED.equals( a.getScope() ) || Artifact.SCOPE_SYSTEM.equals( a.getScope() ) ) { @@ -364,7 +364,7 @@ public class MavenProject return list; } - // TODO: this checking for file == null happens because the resolver has been confused about the root + // TODO this checking for file == null happens because the resolver has been confused about the root // artifact or not. things like the stupid dummy artifact coming from surefire. public List getTestClasspathElements() throws DependencyResolutionRequiredException @@ -408,7 +408,7 @@ public class MavenProject for ( Artifact a : getArtifacts() ) { if ( a.getArtifactHandler().isAddedToClasspath() - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this && ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_RUNTIME.equals( a.getScope() ) ) ) { addArtifactPath( a, list ); @@ -470,7 +470,7 @@ public class MavenProject public String getName() { - // TODO: this should not be allowed to be null. + // TODO this should not be allowed to be null. if ( getModel().getName() != null ) { return getModel().getName(); @@ -1575,10 +1575,10 @@ public class MavenProject for ( Artifact a : getArtifacts() ) { - // TODO: classpath check doesn't belong here - that's the other method + // TODO classpath check doesn't belong here - that's the other method if ( a.getArtifactHandler().isAddedToClasspath() ) { - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this if ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_PROVIDED.equals( a.getScope() ) || Artifact.SCOPE_SYSTEM.equals( a.getScope() ) ) { @@ -1603,7 +1603,7 @@ public class MavenProject for ( Artifact a : getArtifacts() ) { - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this if ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_PROVIDED.equals( a.getScope() ) || Artifact.SCOPE_SYSTEM.equals( a.getScope() ) ) { @@ -1629,7 +1629,7 @@ public class MavenProject for ( Artifact a : getArtifacts() ) { - // TODO: classpath check doesn't belong here - that's the other method + // TODO classpath check doesn't belong here - that's the other method if ( a.getArtifactHandler().isAddedToClasspath() ) { list.add( a ); @@ -1680,7 +1680,7 @@ public class MavenProject for ( Artifact a : getArtifacts() ) { - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this if ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_RUNTIME.equals( a.getScope() ) ) { Dependency dependency = new Dependency(); @@ -1705,9 +1705,9 @@ public class MavenProject for ( Artifact a : getArtifacts() ) { - // TODO: classpath check doesn't belong here - that's the other method + // TODO classpath check doesn't belong here - that's the other method if ( a.getArtifactHandler().isAddedToClasspath() - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this && ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_RUNTIME.equals( a.getScope() ) ) ) { list.add( a ); @@ -1732,7 +1732,7 @@ public class MavenProject { if ( a.getArtifactHandler().isAddedToClasspath() ) { - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this if ( Artifact.SCOPE_SYSTEM.equals( a.getScope() ) ) { addArtifactPath( a, list ); @@ -1749,10 +1749,10 @@ public class MavenProject for ( Artifact a : getArtifacts() ) { - // TODO: classpath check doesn't belong here - that's the other method + // TODO classpath check doesn't belong here - that's the other method if ( a.getArtifactHandler().isAddedToClasspath() ) { - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this if ( Artifact.SCOPE_SYSTEM.equals( a.getScope() ) ) { list.add( a ); @@ -1776,7 +1776,7 @@ public class MavenProject for ( Artifact a : getArtifacts() ) { - // TODO: let the scope handler deal with this + // TODO let the scope handler deal with this if ( Artifact.SCOPE_SYSTEM.equals( a.getScope() ) ) { Dependency dependency = new Dependency(); diff --git a/maven-core/src/main/java/org/apache/maven/project/ProjectSorter.java b/maven-core/src/main/java/org/apache/maven/project/ProjectSorter.java index 504097fbb4..1ca35d87af 100644 --- a/maven-core/src/main/java/org/apache/maven/project/ProjectSorter.java +++ b/maven-core/src/main/java/org/apache/maven/project/ProjectSorter.java @@ -233,7 +233,7 @@ public class ProjectSorter return !( StringUtils.isEmpty( version ) || version.startsWith( "[" ) || version.startsWith( "(" ) ); } - // TODO: !![jc; 28-jul-2005] check this; if we're using '-r' and there are aggregator tasks, this will result in weirdness. + // TODO !![jc; 28-jul-2005] check this; if we're using '-r' and there are aggregator tasks, this will result in weirdness. public MavenProject getTopLevelProject() { if ( topLevelProject == null ) diff --git a/maven-core/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java b/maven-core/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java index 6e13d33235..a1187c3a00 100644 --- a/maven-core/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java +++ b/maven-core/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java @@ -38,7 +38,7 @@ import java.util.List; * attributes of this artifact. * * @author Brett Porter - * @todo I think this exposes a design flaw in that the immutable and mutable parts of an artifact are in one class and + * TODO I think this exposes a design flaw in that the immutable and mutable parts of an artifact are in one class and * should be split. ie scope, file, etc depend on the context of use, whereas everything else is immutable. */ @Deprecated diff --git a/maven-core/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java b/maven-core/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java index 9c1e9e36ca..42bbe45c2c 100644 --- a/maven-core/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java +++ b/maven-core/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java @@ -93,7 +93,7 @@ public class MavenMetadataSource @Requirement private ArtifactFactory repositorySystem; - //TODO: This prevents a cycle in the composition which shows us another problem we need to deal with. + //TODO This prevents a cycle in the composition which shows us another problem we need to deal with. //@Requirement private ProjectBuilder projectBuilder; @@ -175,7 +175,7 @@ public class MavenMetadataSource Artifact relocatedArtifact = null; - //TODO: Not even sure this is really required as the project will be cached in the builder, we'll see this + //TODO Not even sure this is really required as the project will be cached in the builder, we'll see this // is currently the biggest hotspot if ( artifact instanceof ArtifactWithDependencies ) { @@ -658,7 +658,7 @@ public class MavenMetadataSource // MNG-2861: the artifact data has changed. If the available versions where previously // retrieved, we need to update it. - // TODO: shouldn't the versions be merged across relocations? + // TODO shouldn't the versions be merged across relocations? List available = artifact.getAvailableVersions(); if ( available != null && !available.isEmpty() ) { diff --git a/maven-core/src/main/java/org/apache/maven/properties/internal/SystemProperties.java b/maven-core/src/main/java/org/apache/maven/properties/internal/SystemProperties.java index 3d6a969980..c7ab086112 100644 --- a/maven-core/src/main/java/org/apache/maven/properties/internal/SystemProperties.java +++ b/maven-core/src/main/java/org/apache/maven/properties/internal/SystemProperties.java @@ -28,8 +28,6 @@ public class SystemProperties { /** * Thread-safe System.properties copy implementation. - * - * @see https://issues.apache.org/jira/browse/MNG-5670 */ public static void addSystemProperties( Properties props ) { @@ -38,8 +36,8 @@ public class SystemProperties /** * Returns a copy of {@link System#getProperties()} in a thread-safe manner. - * - * @return {@link System#getProperties()} obtained in a thread-safe manner. + * + * @return {@link System#getProperties()} obtained in a thread-safe manner. */ public static Properties getSystemProperties() { diff --git a/maven-core/src/main/java/org/apache/maven/settings/DefaultMavenSettingsBuilder.java b/maven-core/src/main/java/org/apache/maven/settings/DefaultMavenSettingsBuilder.java index 207b9aa472..d3ffd925ec 100644 --- a/maven-core/src/main/java/org/apache/maven/settings/DefaultMavenSettingsBuilder.java +++ b/maven-core/src/main/java/org/apache/maven/settings/DefaultMavenSettingsBuilder.java @@ -127,7 +127,7 @@ public class DefaultMavenSettingsBuilder if ( StringUtils.isEmpty( path ) ) { - // TODO: This replacing shouldn't be necessary as user.home should be in the + // TODO This replacing shouldn't be necessary as user.home should be in the // context of the container and thus the value would be interpolated by Plexus String basedir = System.getProperty( basedirSysProp ); if ( basedir == null ) diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchainManager.java b/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchainManager.java index 9f7a26b4ed..0bdee11a68 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchainManager.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchainManager.java @@ -124,7 +124,7 @@ public class DefaultToolchainManager if ( current != null ) { - //TODO: why is this using the context + //TODO why is this using the context context = session.getPluginContext( desc, current ); } } diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java index 8eddac54c5..134c24da0a 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java @@ -44,16 +44,16 @@ public interface ToolchainManager * maven-toolchains-plugin contains the configuration to select the appropriate * toolchain and is executed at the beginning of the build. * - * @param session the Maven session, must not be {@code null} * @param type the type, must not be {@code null} + * @param context the Maven session, must not be {@code null} * @return the toolchain selected by maven-toolchains-plugin */ Toolchain getToolchainFromBuildContext( String type, MavenSession context ); - + /** * Select all toolchains available in user settings matching the type and requirements, * independently from maven-toolchains-plugin. - * + * * @param session the Maven session, must not be {@code null} * @param type the type, must not be {@code null} * @param requirements the requirements, may be {@code null} diff --git a/maven-core/src/test/java/org/apache/maven/lifecycle/internal/ProjectBuildListTest.java b/maven-core/src/test/java/org/apache/maven/lifecycle/internal/ProjectBuildListTest.java index 047ef9fe95..fd1baf79f6 100644 --- a/maven-core/src/test/java/org/apache/maven/lifecycle/internal/ProjectBuildListTest.java +++ b/maven-core/src/test/java/org/apache/maven/lifecycle/internal/ProjectBuildListTest.java @@ -36,7 +36,7 @@ public class ProjectBuildListTest final ProjectBuildList byTaskSegment = projectBuildList.getByTaskSegment( taskSegment ); assertEquals( projectBuildList.size(), - byTaskSegment.size() ); // Todo: Make multiple segments on projectBuildList + byTaskSegment.size() ); // TODO Make multiple segments on projectBuildList } } diff --git a/maven-core/src/test/java/org/apache/maven/plugin/PluginManagerTest.java b/maven-core/src/test/java/org/apache/maven/plugin/PluginManagerTest.java index f9766017dd..ad9a192373 100644 --- a/maven-core/src/test/java/org/apache/maven/plugin/PluginManagerTest.java +++ b/maven-core/src/test/java/org/apache/maven/plugin/PluginManagerTest.java @@ -103,7 +103,7 @@ public class PluginManagerTest // Tests which exercise the lifecycle executor when it is dealing with individual goals. // ----------------------------------------------------------------------------------------------- - //TODO: These two tests display a lack of symmetry with respect to the input which is a free form string and the + //TODO These two tests display a lack of symmetry with respect to the input which is a free form string and the // mojo descriptor which comes back. All the free form parsing needs to be done somewhere else, this is // really the function of the CLI, and then the pre-processing of that output still needs to be fed into // a hinting process which helps flesh out the full specification of the plugin. The plugin manager should @@ -113,7 +113,7 @@ public class PluginManagerTest public void testRemoteResourcesPlugin() throws Exception { - //TODO: turn an equivalent back on when the RR plugin is released. + //TODO turn an equivalent back on when the RR plugin is released. /* @@ -138,7 +138,7 @@ public class PluginManagerTest */ } - //TODO: this will be the basis of the customizable lifecycle execution so need to figure this out quickly. + //TODO this will be the basis of the customizable lifecycle execution so need to figure this out quickly. public void testSurefirePlugin() throws Exception { diff --git a/maven-core/src/test/java/org/apache/maven/project/artifact/MavenMetadataSourceTest.java b/maven-core/src/test/java/org/apache/maven/project/artifact/MavenMetadataSourceTest.java index 9c770da9d4..5486e9655e 100644 --- a/maven-core/src/test/java/org/apache/maven/project/artifact/MavenMetadataSourceTest.java +++ b/maven-core/src/test/java/org/apache/maven/project/artifact/MavenMetadataSourceTest.java @@ -90,7 +90,7 @@ public class MavenMetadataSourceTest */ } - //TODO: restore these if it makes sense + //TODO restore these if it makes sense /* public void testShouldUseCompileScopeIfDependencyScopeEmpty() throws Exception diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/CleanArgument.java b/maven-embedder/src/main/java/org/apache/maven/cli/CleanArgument.java index 192ed3bde7..03ef00cc0f 100644 --- a/maven-embedder/src/main/java/org/apache/maven/cli/CleanArgument.java +++ b/maven-embedder/src/main/java/org/apache/maven/cli/CleanArgument.java @@ -64,7 +64,7 @@ public class CleanArgument // otherwise, we trim the trailing " and append to the buffer. else { - // TODO: introducing a space here...not sure what else to do but collapse whitespace + // TODO introducing a space here...not sure what else to do but collapse whitespace currentArg.append( ' ' ).append( cleanArgPart ); } diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java index 1cdbd23a04..4e10b05bf0 100644 --- a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java +++ b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java @@ -115,7 +115,7 @@ import java.util.StringTokenizer; import java.util.regex.Matcher; import java.util.regex.Pattern; -// TODO: push all common bits back to plexus cli and prepare for transition to Guice. We don't need 50 ways to make CLIs +// TODO push all common bits back to plexus cli and prepare for transition to Guice. We don't need 50 ways to make CLIs /** * @author Jason van Zyl @@ -211,7 +211,7 @@ public class MavenCli return result; } - // TODO: need to externalize CliRequest + // TODO need to externalize CliRequest public static int doMain( String[] args, ClassWorld classWorld ) { MavenCli cli = new MavenCli(); @@ -283,7 +283,7 @@ public class MavenCli } } - // TODO: need to externalize CliRequest + // TODO need to externalize CliRequest public int doMain( CliRequest cliRequest ) { PlexusContainer localContainer = null; @@ -1510,7 +1510,7 @@ public class MavenCli final String threadConfiguration = commandLine.hasOption( CLIManager.THREADS ) ? commandLine.getOptionValue( CLIManager.THREADS ) : request.getSystemProperties().getProperty( - MavenCli.THREADS_DEPRECATED ); // TODO: Remove this setting. Note that the int-tests use it + MavenCli.THREADS_DEPRECATED ); // TODO Remove this setting. Note that the int-tests use it if ( threadConfiguration != null ) { diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java index 189651b3af..4ebb033cf9 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java @@ -888,7 +888,7 @@ public class DefaultModelBuilder } // - // TODO:jvz Why isn't all this checking the job of the duty of the workspace resolver, we know that we + // TODO jvz Why isn't all this checking the job of the duty of the workspace resolver, we know that we // have a model that is suitable, yet more checks are done here and the one for the version is problematic // before because with parents as ranges it will never work in this scenario. // diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuilder.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuilder.java index 2a49a213f7..e42469acf0 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuilder.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuilder.java @@ -57,10 +57,6 @@ public interface ModelBuilder /** * Performs only the part of {@link ModelBuilder#build(ModelBuildingRequest)} that loads the raw model - * - * @param request - * @return - * @throws ModelBuildingException */ Result buildRawModel( File pomFile, int validationLevel, boolean locationTracking ); diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java index d20f2446ad..bc6e71bee2 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java @@ -66,7 +66,7 @@ public interface ModelBuildingRequest /** * Gets the raw model to build. If not set, model source will be used to load raw model. - * + * * @return The raw model to build or {@code null} if not set. */ Model getRawModel(); @@ -74,7 +74,7 @@ public interface ModelBuildingRequest /** * Set raw model. * - * @param model + * @param rawModel */ ModelBuildingRequest setRawModel( Model rawModel ); diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/Result.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/Result.java index 282887431e..c9d5f68b68 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/building/Result.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/building/Result.java @@ -46,7 +46,7 @@ import com.google.common.collect.Iterables; *

  • error - (partial) model and diagnostics * * Could encode these variants as subclasses, but kept in one for now - * + * * @author bbusjaeger * @param */ @@ -55,9 +55,8 @@ public class Result /** * Success without warnings - * + * * @param model - * @return */ public static Result success( T model ) { @@ -66,10 +65,9 @@ public class Result /** * Success with warnings - * + * * @param model * @param problems - * @return */ public static Result success( T model, Iterable problems ) { @@ -79,10 +77,9 @@ public class Result /** * Success with warnings - * + * * @param model * @param results - * @return */ public static Result success( T model, Result... results ) { @@ -93,7 +90,6 @@ public class Result * Error with problems describing the cause * * @param problems - * @return */ public static Result error( Iterable problems ) { @@ -120,7 +116,6 @@ public class Result * * @param model * @param problems - * @return */ public static Result error( T model, Iterable problems ) { @@ -129,10 +124,9 @@ public class Result /** * New result - determine whether error or success by checking problems for errors - * + * * @param model * @param problems - * @return */ public static Result newResult( T model, Iterable problems ) { @@ -142,10 +136,9 @@ public class Result /** * New result consisting of given result and new problem. Convenience for newResult(result.get(), * concat(result.getProblems(),problems)). - * + * * @param result * @param problem - * @return */ public static Result addProblem( Result result, ModelProblem problem ) { @@ -157,7 +150,6 @@ public class Result * * @param result * @param problems - * @return */ public static Result addProblems( Result result, Iterable problems ) { @@ -172,9 +164,8 @@ public class Result /** * Turns the given results into a single result by combining problems and models into single collection. - * + * * @param results - * @return */ public static Result> newResultSet( Iterable> results ) { diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/StringSearchModelInterpolator.java b/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/StringSearchModelInterpolator.java index a7905803d8..ba077b2469 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/StringSearchModelInterpolator.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/StringSearchModelInterpolator.java @@ -306,7 +306,7 @@ public class StringSearchModelInterpolator new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE ).setMessage( "Failed to interpolate field3: " + field + " on class: " + field.getType().getName() ).setException( - e ) ); // todo: Not entirely the same message + e ) ); // TODO Not entirely the same message } catch ( IllegalAccessException e ) { diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/merge/MavenModelMerger.java b/maven-model-builder/src/main/java/org/apache/maven/model/merge/MavenModelMerger.java index 0007af5e47..e96425d900 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/merge/MavenModelMerger.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/merge/MavenModelMerger.java @@ -109,7 +109,7 @@ public class MavenModelMerger } /* - * TODO: Whether the merge continues recursively into an existing node or not could be an option for the generated + * TODO Whether the merge continues recursively into an existing node or not could be an option for the generated * merger */ @Override @@ -266,7 +266,7 @@ public class MavenModelMerger } /* - * TODO: The order of the merged list could be controlled by an attribute in the model association: target-first, + * TODO The order of the merged list could be controlled by an attribute in the model association: target-first, * source-first, dominant-first, recessive-first */ @Override @@ -352,7 +352,7 @@ public class MavenModelMerger } /* - * TODO: Whether duplicates should be removed looks like an option for the generated merger. + * TODO Whether duplicates should be removed looks like an option for the generated merger. */ @Override protected void mergeBuildBase_Filters( BuildBase target, BuildBase source, boolean sourceDominant, diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/validation/DefaultModelValidator.java b/maven-model-builder/src/main/java/org/apache/maven/model/validation/DefaultModelValidator.java index 9af30c1cb1..59b05329bf 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/validation/DefaultModelValidator.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/validation/DefaultModelValidator.java @@ -532,7 +532,7 @@ public class DefaultModelValidator d.getManagementKey(), d ); /* - * TODO: Extensions like Flex Mojos use custom scopes like "merged", "internal", "external", etc. In + * TODO Extensions like Flex Mojos use custom scopes like "merged", "internal", "external", etc. In * order to don't break backward-compat with those, only warn but don't error out. */ validateEnum( prefix + "scope", problems, Severity.WARNING, Version.V20, d.getScope(), diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/Mojo.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/Mojo.java index 76a2aad7af..73e46fcc1c 100644 --- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/Mojo.java +++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/Mojo.java @@ -58,7 +58,7 @@ public interface Mojo * * @param log a new logger */ - // TODO: not sure about this here, and may want a getLog on here as well/instead + // TODO not sure about this here, and may want a getLog on here as well/instead void setLog( Log log ); /** diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java index 3f7eccc478..e89abed8e8 100644 --- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java +++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java @@ -36,7 +36,7 @@ import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration; * * https://maven.apache.org/developers/mojo-api-specification.html * - * @todo is there a need for the delegation of MavenMojoDescriptor to this? + * TODO is there a need for the delegation of MavenMojoDescriptor to this? * Why not just extend ComponentDescriptor here? */ public class MojoDescriptor @@ -269,7 +269,7 @@ public class MojoDescriptor /** * @return the required dependencies in a specified scope - * @TODO the name is not intelligible + * TODO the name is not intelligible */ @Deprecated public String isDependencyResolutionRequired() diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java index f65f8247b3..e05d86a4a0 100644 --- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java +++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java @@ -176,7 +176,7 @@ public class PluginDescriptor /** * Parse maven-...-plugin. * - * @todo move to plugin-tools-api as a default only + * TODO move to plugin-tools-api as a default only */ public static String getGoalPrefixFromArtifactId( String artifactId ) { @@ -287,7 +287,7 @@ public class PluginDescriptor return null; // no mojo in this POM } - // TODO: could we use a map? Maybe if the parent did that for components too, as this is too vulnerable to + // TODO could we use a map? Maybe if the parent did that for components too, as this is too vulnerable to // changes above not being propagated to the map for ( MojoDescriptor desc : getMojos() ) { diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java index 9508c5136d..865e66b557 100644 --- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java +++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java @@ -313,7 +313,7 @@ public class PluginDescriptorBuilder mojo.setParameters( parameters ); - // TODO: this should not need to be handed off... + // TODO this should not need to be handed off... // ---------------------------------------------------------------------- // Requirements diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/logging/SystemStreamLog.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/logging/SystemStreamLog.java index 90475bf585..38c13164fb 100644 --- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/logging/SystemStreamLog.java +++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/logging/SystemStreamLog.java @@ -141,7 +141,7 @@ public class SystemStreamLog */ public boolean isDebugEnabled() { - // TODO: Not sure how best to set these for this implementation... + // TODO Not sure how best to set these for this implementation... return false; } diff --git a/pom.xml b/pom.xml index b16ea59f84..9f3204b2ce 100644 --- a/pom.xml +++ b/pom.xml @@ -640,14 +640,15 @@ under the License. org.apache.maven.plugins maven-javadoc-plugin - true - true - true - - - http://download.eclipse.org/aether/aether-core/${aetherVersion}/apidocs/ - https://codehaus-plexus.github.io/plexus-containers/plexus-container-default/apidocs/ - + + en + + + provisional + tf + Provisional: + +