Skip to content

Fix JavadocParagraph #2302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>
* 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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ public final class Constants {
* build numbers to perform a "snapshot lock down". Value given here must be <code>maxRemoteBuildNumber + 1</code>
* or greater, otherwise build will fail. How the number to be obtained is left to user (ie by inspecting
* snapshot repository metadata or alike).
*
* <p>
* Note: this feature is present in Maven 3.9.7 but with different key: <code>maven.buildNumber</code>. In Maven 4
* as part of cleanup effort this key was renamed to properly reflect its purpose.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

/**
* Interface that defines some kind of enums that can be extended by Maven plugins or extensions.
*
* <p>
* Implementation must have {@code equals()} and {@code hashCode()} implemented, so implementations of this interface
* can be used as keys.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
*
* <p>
* 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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ default Stream<Phase> allPhases() {

/**
* A phase in the lifecycle.
*
* <p>
* 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.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>
* <strong>Implementation note:</strong> while this method return type is {@link Map}, the
* returned map instance implements {@link java.util.concurrent.ConcurrentMap} as well.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/**
* Version constraint for dependency.
* Constraint is either a range ("[1,2)") or recommended version ("1.0").
*
* <p>
* {@code VersionConstraint} objects are created using the
* {@linkplain org.apache.maven.api.services.VersionParser} service.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* A range of versions.
*
* <p>
* {@code VersionConstraint} objects are created using the
* {@linkplain org.apache.maven.api.services.VersionParser} service.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>
* 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
/**
* Request used to build a {@link org.apache.maven.api.Project} using
* the {@link ProjectBuilder} service.
*
* <p>
* TODO: add validationLevel, activeProfileIds, inactiveProfileIds, resolveDependencies
*
* @since 4.0.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public interface ModelTransformer extends SpiService {

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

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

/**
* Apply a transformation on the effective models.
*
* <p>
* This method will be called on each effective model being loaded,
* just before validation.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

/**
* Describes repository directory metadata.
*
* <p>
* TODO not happy about the store method - they use "this"
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

/**
* Metadata for the artifact version directory of the repository.
*
* <p>
* TODO split instantiation (versioning, plugin mappings) from definition
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>
* 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.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@

/**
* Use a regular expression search to find and resolve expressions within the POM.
*
* <p>
* TODO Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans.
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

/**
* Use a regular expression search to find and resolve expressions within the POM.
*
* <p>
* TODO Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans.
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

/**
* A conflict resolver factory that obtains instances from a plexus container.
*
* <p>
* TODO you don't need the container in here with the active maps (jvz).
* @since 3.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

/**
* Describes a version transformation during artifact resolution.
*
* <p>
* TODO try and refactor to remove abstract methods - not particular happy about current design
*/
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public class MetadataGraphEdge {
/**
* capturing where this link came from
* and where it is linked to.
*
* <p>
* In the first implementation only source used for explanatory function
*/
MetadataGraphVertex source;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ class ProjectInheritanceTest extends AbstractProjectInheritanceTestCase {

/**
* How the test project is set up:
*
* <p>
* 1. dependencyManagement lists dependencies on a &amp; 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.
*
* <p>
* We should see that the resulting size of collected artifacts is two:
* a &amp; b only.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@

/**
* Verifies scope inheritance of direct and transitive dependencies.
*
* <p>
* Should show three behaviors:
*
* <p>
* 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* Provides a fluent API for generating
* <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_sequences">ANSI escape sequences</a>.
*
* <p>
* 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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,24 @@
/**
*
* Note: uses @Typed to limit the types it is available for injection to just ModelProcessor.
*
* <p>
* 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.
*
* <p>
* 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.
*
* <p>
* 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.)
*
* <p>
* 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.
*
* <p>
* 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.)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>
* 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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@

/**
* Interface used to locate the root directory for a given project.
*
* <p>
* 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.
*
* <p>
* The default implementation will look for a {@code .mvn} child directory
* or a {@code pom.xml} containing the {@code root="true"} attribute.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* For more information about the usage tag, have a look to:
* <a href="https://maven.apache.org/developers/mojo-api-specification.html">
* https://maven.apache.org/developers/mojo-api-specification.html</a>
*
* <p>
* TODO is there a need for the delegation of MavenMojoDescriptor to this?
* Why not just extend ComponentDescriptor here?
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ public static String getDefaultPluginGroupId() {

/**
* Parse maven-...-plugin.
*
* <p>
* TODO move to plugin-tools-api as a default only
*/
public static String getGoalPrefixFromArtifactId(String artifactId) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

/**
* Maven GA level metadata generator.
*
* <p>
* Version metadata contains list of existing baseVersions within this GA.
*
* @deprecated since 4.0.0, use {@code maven-api-impl} jar instead
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/**
* This package contain support (mostly abstract) classes, that implement "base" of CLIng.
* In packages below you find actual implementations.
*
* <p>
* Hierarchy:
* <ul>
* <li>{@link org.apache.maven.cling.invoker.LookupInvoker} is the "basis", the common ground of all Maven Tools</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

/**
* Allows core extensions to participate in Maven build session lifecycle.
*
* <p>
* All callback methods (will) follow beforeXXX/afterXXX naming pattern to
* indicate at what lifecycle point it is being called.
*
Expand All @@ -34,7 +34,7 @@ public abstract class AbstractMavenLifecycleParticipant {

/**
* Invoked after all MavenProject instances have been created.
*
* <p>
* This callback is intended to allow extensions to manipulate MavenProjects
* before they are sorted and actual build execution starts.
*
Expand All @@ -47,7 +47,7 @@ public void afterProjectsRead(MavenSession session) throws MavenExecutionExcepti

/**
* Invoked after MavenSession instance has been created.
*
* <p>
* This callback is intended to allow extensions to inject execution properties,
* activate profiles and perform similar tasks that affect MavenProject
* instance construction.
Expand All @@ -62,7 +62,7 @@ public void afterSessionStart(MavenSession session) throws MavenExecutionExcepti

/**
* Invoked after all projects were built.
*
* <p>
* This callback is intended to allow extensions to perform cleanup of any
* allocated external resources after the build. It is invoked on best-effort
* basis and may be missed due to an Error or RuntimeException in Maven core
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

/**
* Exception that occurs when an artifact file is used, but has not been resolved.
*
* <p>
* TODO it may be better for artifact.getFile() to throw it - perhaps it is a runtime exception?
*/
public class DependencyResolutionRequiredException extends Exception {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* Filter to exclude from a list of artifact patterns.
*
* <p>
* TODO I think this is equiv. to exclusion set filter in maven-core
*/
public class ExcludesArtifactFilter extends IncludesArtifactFilter {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public interface ExecutionEvent {

/**
* The possible types of execution events.
*
* <p>
* Note: do not modify this enum, or, make sure that this enum and
* {@link org.apache.maven.api.EventType} have same elements in same order.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ public MavenExecutionResult getResult() {
/**
* Returns the plugin context for given key ({@link PluginDescriptor#getPluginLookupKey()} and
* {@link MavenProject}, never returns {@code null} as if context not present, creates it.
*
* <p>
* <strong>Implementation note:</strong> while this method return type is {@link Map}, the returned map instance
* implements {@link ConcurrentMap} as well.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* Describes the required task segment as provided on the maven command line; i.e. "clean jetty:run install"
*
* <p>
* <strong>NOTE:</strong> This class is not part of any public api and can be changed or deleted without prior notice.
*
* @since 3.0
Expand Down
Loading