diff --git a/api/maven-api-annotations/src/main/java/org/apache/maven/api/annotations/Config.java b/api/maven-api-annotations/src/main/java/org/apache/maven/api/annotations/Config.java index 493b6ceebf35..69328375dd86 100644 --- a/api/maven-api-annotations/src/main/java/org/apache/maven/api/annotations/Config.java +++ b/api/maven-api-annotations/src/main/java/org/apache/maven/api/annotations/Config.java @@ -40,7 +40,7 @@ /** * Specifies the source of the configuration property, which determines when and where the property * will be read from or set for consumption in the Maven build lifecycle. - * + *

* The source indicates whether the property is: * - Set by Maven itself at startup (SYSTEM_PROPERTIES) * - Configured by users through external means like CLI options (USER_PROPERTIES) diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Constants.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Constants.java index d18f0aa3576d..ad01b9cc3e5e 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Constants.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Constants.java @@ -476,7 +476,7 @@ public final class Constants { * build numbers to perform a "snapshot lock down". Value given here must be maxRemoteBuildNumber + 1 * or greater, otherwise build will fail. How the number to be obtained is left to user (ie by inspecting * snapshot repository metadata or alike). - * + *

* Note: this feature is present in Maven 3.9.7 but with different key: maven.buildNumber. In Maven 4 * as part of cleanup effort this key was renamed to properly reflect its purpose. * diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/ExtensibleEnum.java b/api/maven-api-core/src/main/java/org/apache/maven/api/ExtensibleEnum.java index 4b8b74ca0ba9..10b860423d07 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/ExtensibleEnum.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/ExtensibleEnum.java @@ -23,7 +23,7 @@ /** * Interface that defines some kind of enums that can be extended by Maven plugins or extensions. - * + *

* Implementation must have {@code equals()} and {@code hashCode()} implemented, so implementations of this interface * can be used as keys. * diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/JavaPathType.java b/api/maven-api-core/src/main/java/org/apache/maven/api/JavaPathType.java index 7c11ec36daca..be3174afd3bb 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/JavaPathType.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/JavaPathType.java @@ -108,7 +108,7 @@ public enum JavaPathType implements PathType { /** * The path identified by the Java {@code --patch-module} option. * The Java tools location is {@link StandardLocation#PATCH_MODULE_PATH}. - * + *

* Note that this option is incomplete, because it must be followed by a module name. * Use this type only when the module to patch is unknown. * diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Lifecycle.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Lifecycle.java index 37b3fba04311..9a862a791bbc 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Lifecycle.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Lifecycle.java @@ -101,7 +101,7 @@ default Stream allPhases() { /** * A phase in the lifecycle. - * + *

* A phase is identified by its name. It also contains a list of plugins bound to that phase, * a list of {@link Link links}, and a list of sub-phases. This forms a tree of phases. */ diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/Session.java b/api/maven-api-core/src/main/java/org/apache/maven/api/Session.java index 3f43210dc0f2..8b8518749052 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/Session.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/Session.java @@ -133,7 +133,7 @@ public interface Session extends ProtoSession { /** * Returns the plugin context for mojo being executed and the specified * {@link Project}, never returns {@code null} as if context not present, creates it. - * + *

* Implementation note: while this method return type is {@link Map}, the * returned map instance implements {@link java.util.concurrent.ConcurrentMap} as well. * diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/VersionConstraint.java b/api/maven-api-core/src/main/java/org/apache/maven/api/VersionConstraint.java index 4d5d08204eef..8d90c72e96b3 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/VersionConstraint.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/VersionConstraint.java @@ -25,7 +25,7 @@ /** * Version constraint for dependency. * Constraint is either a range ("[1,2)") or recommended version ("1.0"). - * + *

* {@code VersionConstraint} objects are created using the * {@linkplain org.apache.maven.api.services.VersionParser} service. * diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java b/api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java index ca58019dc02e..bd1394576d8d 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/VersionRange.java @@ -24,7 +24,7 @@ /** * A range of versions. - * + *

* {@code VersionConstraint} objects are created using the * {@linkplain org.apache.maven.api.services.VersionParser} service. * diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java b/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java index 277d4ba6ffe1..2a1ab495c621 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/plugin/Mojo.java @@ -26,7 +26,7 @@ * Represents the contract for Mojos to interact with the Maven infrastructure. * Implementations of this interface define specific build-process behaviors * that are triggered during a Maven build lifecycle. - * + *

* The primary entry point is the {@link #execute()} method, which encapsulates * the behavior of the Mojo and serves as the integration point with Maven. This * method may throw an {@link Exception} to signal any issues that prevent diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderRequest.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderRequest.java index 82129b4f1b69..a93363f1be08 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderRequest.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ProjectBuilderRequest.java @@ -36,7 +36,7 @@ /** * Request used to build a {@link org.apache.maven.api.Project} using * the {@link ProjectBuilder} service. - * + *

* TODO: add validationLevel, activeProfileIds, inactiveProfileIds, resolveDependencies * * @since 4.0.0 diff --git a/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelTransformer.java b/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelTransformer.java index 50cc19396900..47b811a144d7 100644 --- a/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelTransformer.java +++ b/api/maven-api-spi/src/main/java/org/apache/maven/api/spi/ModelTransformer.java @@ -58,7 +58,7 @@ public interface ModelTransformer extends SpiService { /** * Apply a transformation on the file model. - * + *

* This method will be called on each file model being loaded, * just before validation. * @@ -73,7 +73,7 @@ default Model transformFileModel(@Nonnull Model model) throws ModelTransformerEx /** * Apply a transformation on the raw models. - * + *

* This method will be called on each raw model being loaded, * just before validation. * @@ -88,7 +88,7 @@ default Model transformRawModel(@Nonnull Model model) throws ModelTransformerExc /** * Apply a transformation on the effective models. - * + *

* This method will be called on each effective model being loaded, * just before validation. * diff --git a/compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java b/compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java index 078ce1175a78..e935d07cbc2f 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java @@ -23,7 +23,7 @@ /** * Describes repository directory metadata. - * + *

* TODO not happy about the store method - they use "this" */ @Deprecated diff --git a/compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java b/compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java index ca1c1696f149..9aae1af6fae8 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java @@ -23,7 +23,7 @@ /** * Metadata for the artifact version directory of the repository. - * + *

* TODO split instantiation (versioning, plugin mappings) from definition */ @Deprecated diff --git a/compat/maven-compat/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java b/compat/maven-compat/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java index c59595b80d10..faa0e438f5e8 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java @@ -35,7 +35,7 @@ /** * Wraps an active project instance to be able to receive updates from its artifact without affecting the original * attributes of this artifact. - * + *

* 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. */ diff --git a/compat/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java b/compat/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java index 34d0b7ade37b..2e42529d859d 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java @@ -56,7 +56,7 @@ /** * Use a regular expression search to find and resolve expressions within the POM. - * + *

* TODO Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans. */ @Deprecated diff --git a/compat/maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java b/compat/maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java index f1dfe3f4adde..dbe2a20d7279 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java @@ -27,7 +27,7 @@ /** * Use a regular expression search to find and resolve expressions within the POM. - * + *

* TODO Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans. */ @Deprecated diff --git a/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java b/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java index cfe9cd43785a..ae1298ee15f1 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java @@ -31,7 +31,7 @@ /** * A conflict resolver factory that obtains instances from a plexus container. - * + *

* TODO you don't need the container in here with the active maps (jvz). * @since 3.0 */ diff --git a/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java b/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java index f86ea3bc58bf..5a3fd9353f29 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java @@ -40,7 +40,7 @@ /** * Describes a version transformation during artifact resolution. - * + *

* TODO try and refactor to remove abstract methods - not particular happy about current design */ @Deprecated diff --git a/compat/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraphEdge.java b/compat/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraphEdge.java index a42efd5c678f..cec2a16ceeef 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraphEdge.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/repository/metadata/MetadataGraphEdge.java @@ -38,7 +38,7 @@ public class MetadataGraphEdge { /** * capturing where this link came from * and where it is linked to. - * + *

* In the first implementation only source used for explanatory function */ MetadataGraphVertex source; diff --git a/compat/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java b/compat/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java index 149b7b04e161..cc2bb872a836 100644 --- a/compat/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java +++ b/compat/maven-compat/src/test/java/org/apache/maven/project/inheritance/t09/ProjectInheritanceTest.java @@ -51,13 +51,13 @@ class ProjectInheritanceTest extends AbstractProjectInheritanceTestCase { /** * How the test project is set up: - * + *

* 1. dependencyManagement lists dependencies on a & b, * with an exclusion on c in b. * 2. the child project lists a dependency on project a only * 3. a depends on b (which is transitive to the child project), * and b depends on c. - * + *

* We should see that the resulting size of collected artifacts is two: * a & b only. */ diff --git a/compat/maven-compat/src/test/java/org/apache/maven/project/inheritance/t10/ProjectInheritanceTest.java b/compat/maven-compat/src/test/java/org/apache/maven/project/inheritance/t10/ProjectInheritanceTest.java index e9004e01133a..54692135ca46 100644 --- a/compat/maven-compat/src/test/java/org/apache/maven/project/inheritance/t10/ProjectInheritanceTest.java +++ b/compat/maven-compat/src/test/java/org/apache/maven/project/inheritance/t10/ProjectInheritanceTest.java @@ -32,9 +32,9 @@ /** * Verifies scope inheritance of direct and transitive dependencies. - * + *

* Should show three behaviors: - * + *

* 1. dependencyManagement should override the scope of transitive dependencies. * 2. Direct dependencies should override the scope of dependencyManagement. * 3. Direct dependencies should inherit scope from dependencyManagement when diff --git a/compat/maven-embedder/src/main/java/org/fusesource/jansi/Ansi.java b/compat/maven-embedder/src/main/java/org/fusesource/jansi/Ansi.java index f861da0098b0..cd299ce88511 100644 --- a/compat/maven-embedder/src/main/java/org/fusesource/jansi/Ansi.java +++ b/compat/maven-embedder/src/main/java/org/fusesource/jansi/Ansi.java @@ -23,7 +23,7 @@ /** * Provides a fluent API for generating * ANSI escape sequences. - * + *

* This class comes from Jansi and is provided for backward compatibility * with maven-shared-utils, while Maven has migrated to JLine (into which Jansi has been merged * since JLine 3.25.0). diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelProcessor.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelProcessor.java index 906e9018f4b3..591009834b58 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelProcessor.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelProcessor.java @@ -36,24 +36,24 @@ /** * * Note: uses @Typed to limit the types it is available for injection to just ModelProcessor. - * + *

* This is because the ModelProcessor interface extends ModelLocator and ModelReader. If we * made this component available under all its interfaces then it could end up being injected * into itself leading to a stack overflow. - * + *

* A side effect of using @Typed is that it translates to explicit bindings in the container. * So instead of binding the component under a 'wildcard' key it is now bound with an explicit * key. Since this is a default component, this will be a plain binding of ModelProcessor to * this implementation type; that is no hint/name. - * + *

* This leads to a second side effect in that any @Inject request for just ModelProcessor in * the same injector is immediately matched to this explicit binding, which means extensions * cannot override this binding. This is because the lookup is always short-circuited in this * specific situation (plain @Inject request, and plain explicit binding for the same type.) - * + *

* The simplest solution is to use a custom @Named here so it isn't bound under the plain key. * This is only necessary for default components using @Typed that want to support overriding. - * + *

* As a non-default component this now gets a negative priority relative to other implementations * of the same interface. Since we want to allow overriding this doesn't matter in this case. * (if it did we could add @Priority of 0 to match the priority given to default components.) diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/resolution/ModelResolver.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/resolution/ModelResolver.java index 9f76ebb2e3ca..b04a41a9d77d 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/resolution/ModelResolver.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/resolution/ModelResolver.java @@ -98,7 +98,7 @@ public interface ModelResolver { * Adds a repository to use for subsequent resolution requests. The order in which repositories are added matters, * repositories that were added first should also be searched first. When multiple repositories with the same * identifier are added, then the value of the replace argument determines the behaviour. - * + *

* If replace is false, then any existing repository with the same ID will remain in use. If replace * is true, the new repository replaces the original. * diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/root/RootLocator.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/root/RootLocator.java index 4f0569a2c267..1578ec3ebe80 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/root/RootLocator.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/root/RootLocator.java @@ -25,12 +25,12 @@ /** * Interface used to locate the root directory for a given project. - * + *

* The root locator is usually looked up from the plexus container. * One notable exception is the computation of the early {@code session.rootDirectory} * property which happens very early. The implementation used in this case * will be discovered using the JDK service mechanism. - * + *

* The default implementation will look for a {@code .mvn} child directory * or a {@code pom.xml} containing the {@code root="true"} attribute. * diff --git a/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java b/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java index 2a43008c1063..fd4c6c1f1fff 100644 --- a/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java +++ b/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java @@ -35,7 +35,7 @@ * For more information about the usage tag, have a look to: * * https://maven.apache.org/developers/mojo-api-specification.html - * + *

* TODO is there a need for the delegation of MavenMojoDescriptor to this? * Why not just extend ComponentDescriptor here? */ diff --git a/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java b/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java index a5232989e4d6..1ec57811b048 100644 --- a/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java +++ b/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java @@ -226,7 +226,7 @@ public static String getDefaultPluginGroupId() { /** * Parse maven-...-plugin. - * + *

* TODO move to plugin-tools-api as a default only */ public static String getGoalPrefixFromArtifactId(String artifactId) { diff --git a/compat/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/VersionsMetadataGenerator.java b/compat/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/VersionsMetadataGenerator.java index e2faf4c7e831..283f0789df56 100644 --- a/compat/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/VersionsMetadataGenerator.java +++ b/compat/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/VersionsMetadataGenerator.java @@ -35,7 +35,7 @@ /** * Maven GA level metadata generator. - * + *

* Version metadata contains list of existing baseVersions within this GA. * * @deprecated since 4.0.0, use {@code maven-api-impl} jar instead diff --git a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/package-info.java b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/package-info.java index 3156066d143d..c6e1c5a982d8 100644 --- a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/package-info.java +++ b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/package-info.java @@ -20,7 +20,7 @@ /** * This package contain support (mostly abstract) classes, that implement "base" of CLIng. * In packages below you find actual implementations. - * + *

* Hierarchy: *