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 fc13eac477d9..7c11ec36daca 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 @@ -203,7 +203,7 @@ public String id() { /** * Returns the identification of this path in the {@code javax.tool} API. * The value may be an instance of {@link StandardLocation} or {@link DocumentationTool.Location}, - * depending which tool will use this location. + * depending on which tool will use this location. * * @return the {@code javax.tool} enumeration value corresponding to this {@code JavaPathType} */ 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 b1d3a4db3243..ebb7617fcafd 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 @@ -71,7 +71,7 @@ public interface Lifecycle extends ExtensibleEnum { /** * Collection of main phases for this lifecycle used with the Maven 3 builders. - * Those builders does not operate on a graph, but on the list and expect a slightly + * Those builders do not operate on a graph, but on the list and expect a slightly * different ordering (mainly unit test being executed before packaging). */ default Collection v3phases() { diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java index 35ee9f328d79..f17daa76acee 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/ArtifactInstaller.java @@ -45,10 +45,10 @@ public interface ArtifactInstaller extends Service { /** * @param session the repository session * @param artifact the {@link ProducedArtifact} to install - * @throws ArtifactInstallerException In case of an error which can be the a given artifact cannot be found or the - * installation has failed. - * @throws IllegalArgumentException in case of parameter {@code session} is {@code null} or - * {@code artifact} is {@code null}. + * @throws ArtifactInstallerException in case of an error which can be a given artifact cannot be found or the + * installation has failed + * @throws IllegalArgumentException if a parameter {@code session} is {@code null} or + * {@code artifact} is {@code null} */ default void install(Session session, ProducedArtifact artifact) { install(session, Collections.singletonList(artifact)); @@ -57,9 +57,9 @@ default void install(Session session, ProducedArtifact artifact) { /** * @param session the repository session * @param artifacts Collection of {@link ProducedArtifact MavenArtifacts} - * @throws ArtifactInstallerException In case of an error which can be the a given artifact cannot be found or the - * installation has failed. - * @throws IllegalArgumentException in case of parameter {@code request} is {@code null} or parameter + * @throws ArtifactInstallerException if the given artifact cannot be found or the + * installation has failed + * @throws IllegalArgumentException if {@code request} is {@code null} or parameter * {@code localRepository} is {@code null} or {@code localRepository} is not a directory * or parameter {@code mavenArtifacts} is {@code null} or * {@code mavenArtifacts.isEmpty()} is {@code true}. diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/SettingsBuilder.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/SettingsBuilder.java index 198e5c5fd930..000ebb883780 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/SettingsBuilder.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/SettingsBuilder.java @@ -27,7 +27,7 @@ import org.apache.maven.api.settings.Settings; /** - * Builds the effective settings from a user settings file and/or a installation settings file. + * Builds the effective settings from a user settings file and/or an installation settings file. * * @since 4.0.0 */ diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlFactory.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlFactory.java index 6fae7f943a3c..733e70b282d1 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlFactory.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlFactory.java @@ -103,7 +103,7 @@ default T fromXmlString(@Nonnull String xml) throws XmlReaderException { } /** - * Simply converts the given content to an xml string. + * Converts the given content to an XML string. * * @param content the object to convert * @return the xml string representation diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java index dda58c162e94..f6317521590d 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderException.java @@ -22,7 +22,7 @@ import org.apache.maven.api.services.MavenException; /** - * An exception thrown during the reading of an xml file. + * An exception thrown while reading an XML file. * * @since 4.0.0 */ diff --git a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java index cba0c2df8866..69852d375fde 100644 --- a/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java +++ b/api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlWriterException.java @@ -22,7 +22,7 @@ import org.apache.maven.api.services.MavenException; /** - * An exception thrown during the writing of an xml file. + * An exception thrown while writing an XML file. * * @since 4.0.0 */ diff --git a/compat/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ArtifactCollector.java b/compat/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ArtifactCollector.java index 7ce05c5e1c79..bdddced4c301 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ArtifactCollector.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/artifact/resolver/ArtifactCollector.java @@ -27,7 +27,7 @@ import org.apache.maven.artifact.resolver.filter.ArtifactFilter; /** - * Artifact collector - takes a set of original artifacts and resolves all of the best versions to use + * Artifact collector - takes a set of original artifacts and resolves the best versions to use * along with their metadata. No artifacts are downloaded. */ @Deprecated diff --git a/compat/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactCollector.java b/compat/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactCollector.java index 0c0a235a9ade..6001f46e7076 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactCollector.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactCollector.java @@ -22,7 +22,7 @@ import javax.inject.Singleton; /** - * Artifact collector - takes a set of original artifacts and resolves all of the best versions to use + * Artifact collector - takes a set of original artifacts and resolves the best versions to use * along with their metadata. No artifacts are downloaded. */ @Deprecated diff --git a/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java b/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java index 3073a4105379..49c8fa645af0 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java @@ -602,7 +602,7 @@ private void handleChecksumFailure(String checksumPolicy, String message, Throwa // warn if it is set to anything other than ignore logger.warn("*** CHECKSUM FAILED - " + message + " - IGNORING"); } - // otherwise it is ignore + // otherwise it is ignored } private void verifyChecksum( diff --git a/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/LegacyArtifactCollector.java b/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/LegacyArtifactCollector.java index 945a1e25c384..fcee2bc842d1 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/LegacyArtifactCollector.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/LegacyArtifactCollector.java @@ -32,9 +32,8 @@ import org.apache.maven.repository.legacy.resolver.conflict.ConflictResolver; /** - * Artifact collector - takes a set of original artifacts and resolves all of the best versions to use + * Artifact collector - takes a set of original artifacts and resolves the best versions to use * along with their metadata. No artifacts are downloaded. - * */ @Deprecated @SuppressWarnings("checkstyle:parameternumber") diff --git a/compat/maven-compat/src/main/java/org/apache/maven/repository/metadata/DefaultClasspathTransformation.java b/compat/maven-compat/src/main/java/org/apache/maven/repository/metadata/DefaultClasspathTransformation.java index 0a23b4b7e555..616467a0f93c 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/repository/metadata/DefaultClasspathTransformation.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/repository/metadata/DefaultClasspathTransformation.java @@ -93,8 +93,7 @@ protected ClasspathGraphVisitor(MetadataGraph cleanGraph, ClasspathContainer cpc } // ----------------------------------------------------------------------- - protected void visit(MetadataGraphVertex node) // , String version, String artifactUri ) - { + protected void visit(MetadataGraphVertex node) { ArtifactMetadata md = node.getMd(); if (visited.contains(node)) { return; diff --git a/compat/maven-compat/src/main/java/org/apache/maven/toolchain/java/JavaToolchainFactory.java b/compat/maven-compat/src/main/java/org/apache/maven/toolchain/java/JavaToolchainFactory.java index de8414935c47..2c0e24279ca3 100644 --- a/compat/maven-compat/src/main/java/org/apache/maven/toolchain/java/JavaToolchainFactory.java +++ b/compat/maven-compat/src/main/java/org/apache/maven/toolchain/java/JavaToolchainFactory.java @@ -97,7 +97,7 @@ public ToolchainPrivate createToolchain(ToolchainModel model) throws Misconfigur public ToolchainPrivate createDefaultToolchain() { // not sure it's necessary to provide a default toolchain here. - // only version can be eventually supplied, and + // only version can be eventually supplied. return null; } 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 4a446b65c416..f861da0098b0 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 @@ -84,7 +84,7 @@ public int bgBright() { } /** - * Display attributes, also know as + * Display attributes, also known as * SGR * (Select Graphic Rendition) parameters. */ 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 bb99dfee250b..906e9018f4b3 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 @@ -41,12 +41,12 @@ * 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. + * 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, ie. no hint/name. + * 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 + * 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.) diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java index fc33bc3e6ab0..9a572b9b5855 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java @@ -104,7 +104,7 @@ public interface ModelBuildingRequest { /** * Sets the POM file of the project to build. Note that providing the path to a POM file via this method will make * the model builder operate in project mode. This mode is meant for effective models that are employed during the - * build process of a local project. Hence the effective model will support the notion of a project directory. To + * build process of a local project. Hence, the effective model will support the notion of a project directory. To * build the model for a POM from the repository, use {@link #setModelSource(ModelSource)} in combination with a * {@link FileModelSource} instead. * @@ -154,7 +154,7 @@ public interface ModelBuildingRequest { * builder will only produce an interim result which may be used to analyze inter-model dependencies before the * final invocation of the model builder is performed. * - * @return {@code true} if two-phase building is enabled, {@code false} if the model should be build in a single + * @return {@code true} if two-phase building is enabled, {@code false} if the model should be built in a single * step. */ boolean isTwoPhaseBuilding(); @@ -164,7 +164,7 @@ public interface ModelBuildingRequest { * interim result which may be used to analyze inter-model dependencies before the final invocation of the model * builder is performed. * - * @param twoPhaseBuilding {@code true} to enable two-phase building, {@code false} if the model should be build in + * @param twoPhaseBuilding {@code true} to enable two-phase building, {@code false} if the model should be built in * a single step. * @return This request, never {@code null}. */ diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelCache.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelCache.java index 9cdd510181b8..50f2d70cedbf 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelCache.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/building/ModelCache.java @@ -22,7 +22,7 @@ * Caches auxiliary data used during model building like already processed raw/effective models. The data in the cache * is meant for exclusive consumption by the model builder and is opaque to the cache implementation. The cache key is * formed by a combination of group id, artifact id, version and tag. The first three components generally refer to the - * identify of a model. The tag allows for further classification of the associated data on the sole discretion of the + * identity of a model. The tag allows for further classification of the associated data on the sole discretion of the * model builder. * * @deprecated use {@code org.apache.maven.api.services.ModelBuilder} instead diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/AbstractStringBasedModelInterpolator.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/AbstractStringBasedModelInterpolator.java index bec0625d5b08..13b81619a531 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/AbstractStringBasedModelInterpolator.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/AbstractStringBasedModelInterpolator.java @@ -158,7 +158,7 @@ public Object getValue(String expression) { valueSources.add(new MapBasedValueSource(config.getUserProperties())); - // Overwrite existing values in model properties. Otherwise it's not possible + // Overwrite existing values in model properties. Otherwise, it's not possible // to define them via command line e.g.: mvn -Drevision=6.5.7 ... versionProcessor.overwriteModelProperties(modelProperties, config); valueSources.add(new MapBasedValueSource(modelProperties)); diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/reflection/ClassMap.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/reflection/ClassMap.java index 11cffe3d8181..6f86ff2bd9e1 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/reflection/ClassMap.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/interpolation/reflection/ClassMap.java @@ -127,9 +127,9 @@ private void populateMethodCache() { Method publicMethod = getPublicMethod(method); // it is entirely possible that there is no public method for - // the methods of this class (i.e. in the facade, a method + // the methods of this class; i.e. in the facade, a method // that isn't on any of the interfaces or superclass - // in which case, ignore it. Otherwise, map and cache + // in which case, ignore it. Otherwise, map and cache. if (publicMethod != null) { methodMap.add(publicMethod); methodCache.put(makeMethodKey(publicMethod), publicMethod); diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/io/ModelParseException.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/io/ModelParseException.java index 054cb47b4015..63c3625bbc65 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/io/ModelParseException.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/io/ModelParseException.java @@ -21,7 +21,7 @@ import java.io.IOException; /** - * Signals a failure to parse the POM due to invalid syntax (e.g. non well formed XML or unknown elements). + * Signals a failure to parse the POM due to invalid syntax (e.g. non well-formed XML or unknown elements). * * @deprecated use {@code org.apache.maven.api.services.xml.ModelXmlFactory} instead */ diff --git a/compat/maven-model-builder/src/main/java/org/apache/maven/model/locator/ModelLocator.java b/compat/maven-model-builder/src/main/java/org/apache/maven/model/locator/ModelLocator.java index 4f9dd806f01e..2876359c74b0 100644 --- a/compat/maven-model-builder/src/main/java/org/apache/maven/model/locator/ModelLocator.java +++ b/compat/maven-model-builder/src/main/java/org/apache/maven/model/locator/ModelLocator.java @@ -30,7 +30,7 @@ public interface ModelLocator { /** * Locates the POM file within the specified project directory. In case the given project directory does not exist - * or does not contain a POM file, the return value indicates the expected path to the POM file. Sub directories of + * or does not contain a POM file, the return value indicates the expected path to the POM file. Subdirectories of * the project directory will not be considered when locating the POM file. The return value will be an absolute * path if the project directory is given as an absolute path. * 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 c5a49dffa5b6..9f76ebb2e3ca 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 @@ -97,13 +97,13 @@ 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 is determines the behaviour. + * identifier are added, then the value of the replace argument determines the behaviour. * - * If replace is false than any existing repository with the same Id will remain in use. If replace - * is true the new repository replaces the original. + * 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. * - * @param repository The repository to add to the internal search chain, must not be {@code null}. - * @throws InvalidRepositoryException If the repository could not be added (e.g. due to invalid URL or layout). + * @param repository the repository to add to the internal search chain, must not be {@code null} + * @throws InvalidRepositoryException if the repository could not be added (e.g. due to invalid URL or layout) */ void addRepository(Repository repository, boolean replace) throws InvalidRepositoryException; diff --git a/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/AbstractMojo.java b/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/AbstractMojo.java index 8a168f796d00..f9ea24d94ee6 100644 --- a/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/AbstractMojo.java +++ b/compat/maven-plugin-api/src/main/java/org/apache/maven/plugin/AbstractMojo.java @@ -154,7 +154,7 @@ public void setLog(Log log) { /** *

- * Returns the logger that has been injected into this mojo. If no logger has been setup yet, a + * Returns the logger that has been injected into this mojo. If no logger has been set up yet, a * SystemStreamLog logger will be created and returned. *

* Note: diff --git a/compat/maven-settings-builder/src/main/java/org/apache/maven/settings/building/SettingsBuildingException.java b/compat/maven-settings-builder/src/main/java/org/apache/maven/settings/building/SettingsBuildingException.java index be47fe1ede86..97e69b68837c 100644 --- a/compat/maven-settings-builder/src/main/java/org/apache/maven/settings/building/SettingsBuildingException.java +++ b/compat/maven-settings-builder/src/main/java/org/apache/maven/settings/building/SettingsBuildingException.java @@ -24,7 +24,7 @@ import java.util.List; /** - * Signals one ore more errors during settings building. The settings builder tries to collect as many problems as + * Signals one or more errors during settings building. The settings builder tries to collect as many problems as * possible before eventually failing to provide callers with rich error information. Use {@link #getProblems()} to * query the details of the failure. * diff --git a/compat/maven-settings-builder/src/main/java/org/apache/maven/settings/io/SettingsParseException.java b/compat/maven-settings-builder/src/main/java/org/apache/maven/settings/io/SettingsParseException.java index 3d4f055eb821..5d7a0aff843c 100644 --- a/compat/maven-settings-builder/src/main/java/org/apache/maven/settings/io/SettingsParseException.java +++ b/compat/maven-settings-builder/src/main/java/org/apache/maven/settings/io/SettingsParseException.java @@ -21,7 +21,7 @@ import java.io.IOException; /** - * Signals a failure to parse the settings due to invalid syntax (e.g. non well formed XML or unknown elements). + * Signals a failure to parse the settings due to invalid syntax (e.g. non well-formed XML or unknown elements). * * @deprecated since 4.0.0, use {@link org.apache.maven.api.services.xml.SettingsXmlFactory} instead */ diff --git a/compat/maven-settings/src/main/java/org/apache/maven/settings/io/xpp3/SettingsXpp3Reader.java b/compat/maven-settings/src/main/java/org/apache/maven/settings/io/xpp3/SettingsXpp3Reader.java index 14f06741528f..7ff965afa8f7 100644 --- a/compat/maven-settings/src/main/java/org/apache/maven/settings/io/xpp3/SettingsXpp3Reader.java +++ b/compat/maven-settings/src/main/java/org/apache/maven/settings/io/xpp3/SettingsXpp3Reader.java @@ -64,14 +64,6 @@ public void setAddDefaultEntities(boolean addDefaultEntities) { delegate.setAddDefaultEntities(addDefaultEntities); } - /** - * @param reader a reader object. - * @param strict a strict object. - * @throws IOException IOException if any. - * @throws XmlPullParserException XmlPullParserException if - * any. - * @return Settings - */ public Settings read(Reader reader, boolean strict) throws IOException, XmlPullParserException { try { return new Settings(delegate.read(reader, strict, null)); @@ -80,13 +72,6 @@ public Settings read(Reader reader, boolean strict) throws IOException, XmlPullP } } - /** - * @param reader a reader object. - * @throws IOException IOException if any. - * @throws XmlPullParserException XmlPullParserException if - * any. - * @return Model - */ public Settings read(Reader reader) throws IOException, XmlPullParserException { try { return new Settings(delegate.read(reader)); @@ -95,16 +80,6 @@ public Settings read(Reader reader) throws IOException, XmlPullParserException { } } - /** - * Method read. - * - * @param in a in object. - * @param strict a strict object. - * @throws IOException IOException if any. - * @throws XmlPullParserException XmlPullParserException if - * any. - * @return Settings - */ public Settings read(InputStream in, boolean strict) throws IOException, XmlPullParserException { try { return new Settings(delegate.read(in, strict, null)); @@ -113,15 +88,6 @@ public Settings read(InputStream in, boolean strict) throws IOException, XmlPull } } - /** - * Method read. - * - * @param in a in object. - * @throws IOException IOException if any. - * @throws XmlPullParserException XmlPullParserException if - * any. - * @return Settings - */ public Settings read(InputStream in) throws IOException, XmlPullParserException { try { return new Settings(delegate.read(in)); @@ -130,16 +96,6 @@ public Settings read(InputStream in) throws IOException, XmlPullParserException } } - /** - * Method read. - * - * @param parser a parser object. - * @param strict a strict object. - * @throws IOException IOException if any. - * @throws XmlPullParserException XmlPullParserException if - * any. - * @return Settings - */ public Settings read(XMLStreamReader parser, boolean strict) throws IOException, XmlPullParserException { try { return new Settings(delegate.read(parser, strict, null)); diff --git a/compat/maven-toolchain-builder/src/main/java/org/apache/maven/toolchain/io/ToolchainsParseException.java b/compat/maven-toolchain-builder/src/main/java/org/apache/maven/toolchain/io/ToolchainsParseException.java index b169dd92fdbc..d2d6932d891c 100644 --- a/compat/maven-toolchain-builder/src/main/java/org/apache/maven/toolchain/io/ToolchainsParseException.java +++ b/compat/maven-toolchain-builder/src/main/java/org/apache/maven/toolchain/io/ToolchainsParseException.java @@ -21,7 +21,7 @@ import java.io.IOException; /** - * Signals a failure to parse the toolchains due to invalid syntax (e.g. non well formed XML or unknown elements). + * Signals a failure to parse the toolchains due to invalid syntax (e.g. non well-formed XML or unknown elements). * * @since 3.3.0 */ diff --git a/impl/maven-core/src/main/java/org/apache/maven/DefaultMaven.java b/impl/maven-core/src/main/java/org/apache/maven/DefaultMaven.java index 41d87dd85e4b..368827853a35 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/DefaultMaven.java +++ b/impl/maven-core/src/main/java/org/apache/maven/DefaultMaven.java @@ -276,9 +276,8 @@ private MavenExecutionResult doExecute( // because the participant is free to change the dependencies of a project which can potentially change the // topological order of the projects, and therefore can potentially change the build order. // - // Note that participants may affect the topological order of the projects but it is + // Note that participants may affect the topological order of the projects, but it is // not expected that a participant will add or remove projects from the session. - // graphResult = buildGraph(session); diff --git a/impl/maven-core/src/main/java/org/apache/maven/artifact/factory/DefaultArtifactFactory.java b/impl/maven-core/src/main/java/org/apache/maven/artifact/factory/DefaultArtifactFactory.java index 2bc70332f207..368ef291f040 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/artifact/factory/DefaultArtifactFactory.java +++ b/impl/maven-core/src/main/java/org/apache/maven/artifact/factory/DefaultArtifactFactory.java @@ -162,7 +162,7 @@ private Artifact createArtifact( } else if (Artifact.SCOPE_TEST.equals(scope) || Artifact.SCOPE_PROVIDED.equals(scope)) { return null; } else if (Artifact.SCOPE_COMPILE.equals(scope) && Artifact.SCOPE_COMPILE.equals(inheritedScope)) { - // added to retain compile artifactScope. Remove if you want compile inherited as runtime + // added to retain compile artifactScope. Remove if you want to compile inherited as runtime desiredScope = Artifact.SCOPE_COMPILE; } diff --git a/impl/maven-core/src/main/java/org/apache/maven/exception/DefaultExceptionHandler.java b/impl/maven-core/src/main/java/org/apache/maven/exception/DefaultExceptionHandler.java index fdb06a825d79..98db9808123c 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/exception/DefaultExceptionHandler.java +++ b/impl/maven-core/src/main/java/org/apache/maven/exception/DefaultExceptionHandler.java @@ -76,7 +76,7 @@ - plugin dependency metadata missing - plugin dependency metadata retrieval problem - plugin configuration problem -- plugin execution failure due to something that is know to possibly go wrong (like compilation failure) +- plugin execution failure due to something that is known to possibly go wrong (like compilation failure) - plugin execution error due to something that is not expected to go wrong (the compiler executable missing) - asking to use a plugin for which you do not have a version defined - tools to easily select versions - goal not found in a plugin (probably could list the ones that are) diff --git a/impl/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionAnalyzer.java b/impl/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionAnalyzer.java index 0ce454a2766e..920c8b6cd338 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionAnalyzer.java +++ b/impl/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionAnalyzer.java @@ -21,7 +21,7 @@ import java.util.Optional; /** - * Instances of this class are responsible for determining whether it makes sense to "resume" a build (i.e., using + * Instances of this class are responsible for determining whether it makes sense to "resume" a build using * the {@code --resume} flag. */ public interface BuildResumptionAnalyzer { diff --git a/impl/maven-core/src/main/java/org/apache/maven/extension/internal/CoreExtensionEntry.java b/impl/maven-core/src/main/java/org/apache/maven/extension/internal/CoreExtensionEntry.java index e482019a9487..f19a5bf6ef57 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/extension/internal/CoreExtensionEntry.java +++ b/impl/maven-core/src/main/java/org/apache/maven/extension/internal/CoreExtensionEntry.java @@ -86,7 +86,7 @@ public Set getExportedPackages() { } /** - * The key that can must used to identify the configuration using the + * The key that can be used to identify the configuration using the * {@link javax.inject.Named} annotation. */ public String getKey() { diff --git a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java index 57f95e4ca41b..9bd8429c4de2 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java +++ b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java @@ -84,7 +84,7 @@ public void execute(MavenSession session) { // These methods deal with construction intact Plugin object that look like they come from a standard // block in a Maven POM. We have to do some wiggling to pull the sources of information - // together and this really shows the problem of constructing a sensible default configuration but + // together and this really shows the problem of constructing a sensible default configuration, but // it's all encapsulated here so it appears normalized to the POM builder. // We are going to take the project packaging and find all plugin in the default lifecycle and create diff --git a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java index e3b2817a6077..f85a9bc51d05 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java +++ b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java @@ -91,7 +91,7 @@ public Lifecycle get(String phase) { /** * We use this to map all phases to the lifecycle that contains it. This is used so that a user can specify the - * phase they want to execute and we can easily determine what lifecycle we need to run. + * phase they want to execute, and we can easily determine what lifecycle we need to run. * * @return A map of lifecycles, indexed on id */ diff --git a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecyclePluginAnalyzer.java b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecyclePluginAnalyzer.java index 42614f3487c3..6066febf3337 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecyclePluginAnalyzer.java +++ b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecyclePluginAnalyzer.java @@ -70,13 +70,12 @@ public DefaultLifecyclePluginAnalyzer(Lookup lookup, DefaultLifecycles defaultLi // These methods deal with construction intact Plugin object that look like they come from a standard // block in a Maven POM. We have to do some wiggling to pull the sources of information - // together and this really shows the problem of constructing a sensible default configuration but + // together and this really shows the problem of constructing a sensible default configuration, but // it's all encapsulated here so it appears normalized to the POM builder. // We are going to take the project packaging and find all plugins in the default lifecycle and create // fully populated Plugin objects, including executions with goals and default configuration taken // from the plugin.xml inside a plugin. - // @Override public Set getPluginsBoundByDefaultToAllLifecycles(String packaging) { diff --git a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultProjectArtifactFactory.java b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultProjectArtifactFactory.java index 6ae029efdea5..605b301b3b16 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultProjectArtifactFactory.java +++ b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultProjectArtifactFactory.java @@ -131,7 +131,7 @@ private static String getEffectiveScope(String originalScope, String inheritedSc // system scope come through unchanged... effectiveScope = Artifact.SCOPE_SYSTEM; } else if (Artifact.SCOPE_COMPILE.equals(originalScope) && Artifact.SCOPE_COMPILE.equals(inheritedScope)) { - // added to retain compile scope. Remove if you want compile inherited as runtime + // added to retain compile scope. Remove if you want to compile inherited as runtime effectiveScope = Artifact.SCOPE_COMPILE; } else if (Artifact.SCOPE_TEST.equals(inheritedScope)) { effectiveScope = Artifact.SCOPE_TEST; diff --git a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleDependencyResolver.java b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleDependencyResolver.java index a0f30a65737b..96b3ff0b8fbd 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleDependencyResolver.java +++ b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/LifecycleDependencyResolver.java @@ -263,7 +263,7 @@ private Set getDependencies( /* * MNG-2277, the check below compensates for our bad plugin support where we ended up with aggregator - * plugins that require dependency resolution although they usually run in phases of the build where project + * plugins that require dependency resolution, although they usually run in phases of the build where project * artifacts haven't been assembled yet. The prime example of this is "mvn release:prepare". */ if (aggregating && areAllDependenciesInReactor(session.getProjects(), result.getUnresolvedDependencies())) { diff --git a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/multithreaded/MultiThreadedBuilder.java b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/multithreaded/MultiThreadedBuilder.java index 6f13050ebd62..18157c06f2c9 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/multithreaded/MultiThreadedBuilder.java +++ b/impl/maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/multithreaded/MultiThreadedBuilder.java @@ -85,7 +85,7 @@ public void build( session.getRequest().getDegreeOfConcurrency(), session.getProjects().size()); boolean parallel = nThreads > 1; - // Propagate the parallel flag to the root session and all of the cloned sessions in each project segment + // Propagate the parallel flag to the root session and all the cloned sessions in each project segment session.setParallel(parallel); for (ProjectSegment segment : projectBuilds) { segment.getSession().setParallel(parallel); diff --git a/impl/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuilder.java b/impl/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuilder.java index 0ad679efafdc..4340d2bf71b6 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuilder.java +++ b/impl/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuilder.java @@ -842,7 +842,7 @@ private void initParent(MavenProject project, ModelBuilderResult result) { MavenProject parent = projectIndex.get(parentModel.getId()); if (parent == null) { // - // At this point the DefaultModelBuildingListener has fired and it populates the + // At this point the DefaultModelBuildingListener has fired, and it populates the // remote repositories with those found in the pom.xml, along with the existing externally // defined repositories. // diff --git a/impl/maven-core/src/main/java/org/apache/maven/project/collector/MultiModuleCollectionStrategy.java b/impl/maven-core/src/main/java/org/apache/maven/project/collector/MultiModuleCollectionStrategy.java index f3570d5ae3f9..3e6616a80cd4 100644 --- a/impl/maven-core/src/main/java/org/apache/maven/project/collector/MultiModuleCollectionStrategy.java +++ b/impl/maven-core/src/main/java/org/apache/maven/project/collector/MultiModuleCollectionStrategy.java @@ -136,12 +136,12 @@ private boolean isRequestedProjectCollected(MavenExecutionRequest request, List< * - Because of inter-module dependency collection, all projects in the multi-module project are collected. * - The plugin is not yet installed in a repository. * - * Therefore the build fails because the plugin is not found and plugins cannot be built in the same session. + * Therefore, the build fails because the plugin is not found and plugins cannot be built in the same session. * * The integration test for MNG-5572 is an * example of this scenario. * - * @return true if the module which fails to collect the inter-module plugin is not part of the build. + * @return true if the module which fails to collect the inter-module plugin is not part of the build */ private boolean isModuleOutsideRequestScopeDependingOnPluginModule( MavenExecutionRequest request, ProjectBuildingException exception) { diff --git a/impl/maven-core/src/site/apt/offline-mode.apt b/impl/maven-core/src/site/apt/offline-mode.apt index 81bc88931515..0311bc8ce0fa 100644 --- a/impl/maven-core/src/site/apt/offline-mode.apt +++ b/impl/maven-core/src/site/apt/offline-mode.apt @@ -35,7 +35,7 @@ Offline Mode Design earmarked as remote should be accessed, regardless of whether it is actually a physically local resource. - NOTE: One side-effect of this design change is that all offline-mode code can + NOTE: One side effect of this design change is that all offline-mode code can be isolated to maven-core, maven-plugin-descriptor, and [possibly] maven-artifact. Usage of maven-wagon will be determined by an offline-aware manager. diff --git a/impl/maven-executor/src/main/java/org/apache/maven/api/cli/Executor.java b/impl/maven-executor/src/main/java/org/apache/maven/api/cli/Executor.java index 2d2ddf40d130..995e43018fc3 100644 --- a/impl/maven-executor/src/main/java/org/apache/maven/api/cli/Executor.java +++ b/impl/maven-executor/src/main/java/org/apache/maven/api/cli/Executor.java @@ -50,9 +50,9 @@ public interface Executor extends AutoCloseable { int execute(@Nonnull ExecutorRequest executorRequest) throws ExecutorException; /** - * Returns the Maven version that provided {@link ExecutorRequest} point at (would use). Please note, that this - * operation, depending on underlying implementation may be costly. If caller use this method often, it is - * caller responsibility to properly cache returned values (key can be {@link ExecutorRequest#installationDirectory()}. + * Returns the Maven version that provided {@link ExecutorRequest} point at (would use). This + * operation, depending on the underlying implementation, can be costly. If a caller uses this method often, it is + * the caller's responsibility to properly cache returned values. (key can be {@link ExecutorRequest#installationDirectory()}. * * @param executorRequest the request containing all necessary information for the execution * @return a string representing the Maven version or {@link #UNKNOWN_VERSION} diff --git a/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultModelXmlFactory.java b/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultModelXmlFactory.java index e0d5731ac350..7a5abd7d8235 100644 --- a/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultModelXmlFactory.java +++ b/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultModelXmlFactory.java @@ -145,7 +145,7 @@ public void write(XmlWriterRequest request) throws XmlWriterException { /** * Simply parse the given xml string. * - * @param xml the input xml string + * @param xml the input XML string * @return the parsed object * @throws XmlReaderException if an error occurs during the parsing * @see #toXmlString(Object) @@ -155,10 +155,10 @@ public static Model fromXml(@Nonnull String xml) throws XmlReaderException { } /** - * Simply converts the given content to an xml string. + * Simply converts the given content to an XML string. * * @param content the object to convert - * @return the xml string representation + * @return the XML string representation * @throws XmlWriterException if an error occurs during the transformation * @see #fromXmlString(String) */ diff --git a/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultPluginXmlFactory.java b/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultPluginXmlFactory.java index f3f20b281551..dec67b0257b9 100644 --- a/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultPluginXmlFactory.java +++ b/impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultPluginXmlFactory.java @@ -104,7 +104,7 @@ public void write(XmlWriterRequest request) throws XmlWriterEx /** * Simply parse the given xml string. * - * @param xml the input xml string + * @param xml the input XML string * @return the parsed object * @throws XmlReaderException if an error occurs during the parsing * @see #toXmlString(Object) @@ -114,10 +114,10 @@ public static PluginDescriptor fromXml(@Nonnull String xml) throws XmlReaderExce } /** - * Simply converts the given content to an xml string. + * Simply converts the given content to an XML string. * * @param content the object to convert - * @return the xml string representation + * @return the XML string representation * @throws XmlWriterException if an error occurs during the transformation * @see #fromXmlString(String) */ diff --git a/impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultInterpolator.java b/impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultInterpolator.java index 59ae3a78b000..41554274cdbf 100644 --- a/impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultInterpolator.java +++ b/impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultInterpolator.java @@ -118,7 +118,7 @@ public void performSubstitution( * then the corresponding property value is substituted for the variable * placeholder. Multiple variable placeholders may exist in the * specified value as well as nested variable placeholders, which - * are substituted from inner most to outer most. Configuration + * are substituted from innermost to outermost. Configuration * properties override system properties. *

* @@ -144,7 +144,7 @@ public String substVars(String val, String currentKey, Set cycleMap, Map * then the corresponding property value is substituted for the variable * placeholder. Multiple variable placeholders may exist in the * specified value as well as nested variable placeholders, which - * are substituted from inner most to outer most. Configuration + * are substituted from innermost to outermost. Configuration * properties override system properties. *

* @@ -176,7 +176,7 @@ public String substVars( * then the corresponding property value is substituted for the variable * placeholder. Multiple variable placeholders may exist in the * specified value as well as nested variable placeholders, which - * are substituted from inner most to outer most. Configuration + * are substituted from innermost to outermost. Configuration * properties override system properties. *

* diff --git a/impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultModelProcessor.java b/impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultModelProcessor.java index 425563789ccf..bcd0a191f8c3 100644 --- a/impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultModelProcessor.java +++ b/impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultModelProcessor.java @@ -49,8 +49,8 @@ * * 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, ie. no hint/name. + * 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 diff --git a/impl/maven-impl/src/main/java/org/apache/maven/impl/model/reflection/ClassMap.java b/impl/maven-impl/src/main/java/org/apache/maven/impl/model/reflection/ClassMap.java index ea045f18b479..544a4c411dca 100644 --- a/impl/maven-impl/src/main/java/org/apache/maven/impl/model/reflection/ClassMap.java +++ b/impl/maven-impl/src/main/java/org/apache/maven/impl/model/reflection/ClassMap.java @@ -124,9 +124,9 @@ private void populateMethodCache() { Method publicMethod = getPublicMethod(method); // it is entirely possible that there is no public method for - // the methods of this class (i.e. in the facade, a method + // the methods of this class; i.e., in the facade, a method // that isn't on any of the interfaces or superclass - // in which case, ignore it. Otherwise, map and cache + // in which case, ignore it. Otherwise, map and cache. if (publicMethod != null) { methodMap.add(publicMethod); methodCache.put(makeMethodKey(publicMethod), publicMethod); diff --git a/impl/maven-impl/src/main/java/org/apache/maven/impl/util/Os.java b/impl/maven-impl/src/main/java/org/apache/maven/impl/util/Os.java index f7d14096785b..667f02ad8739 100644 --- a/impl/maven-impl/src/main/java/org/apache/maven/impl/util/Os.java +++ b/impl/maven-impl/src/main/java/org/apache/maven/impl/util/Os.java @@ -123,7 +123,7 @@ public class Os { private static final String FAMILY_UNKNOWN = "unknown"; /** - * OpenJDK is reported to call MacOS X "Darwin" + * OpenJDK is reported to call Mac OS X "Darwin" * * @see bugzilla issue * @see HADOOP-3318 @@ -177,7 +177,7 @@ public static boolean isFamily(String family, String actualOsName) { || actualOsName.contains("98") || actualOsName.contains("me") // wince isn't really 9x, but crippled enough to - // be a muchness. Maven doesnt run on CE, anyway. + // be a muchness. Maven doesn't run on CE, anyway. || actualOsName.contains("ce")); isNT = !is9x; }