This is an automated email from the ASF dual-hosted git repository. desruisseaux pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-compiler-plugin.git
commit c6c0884bf0f29b64066d9de83271978f180abcaf Author: Martin Desruisseaux <[email protected]> AuthorDate: Wed Oct 15 12:42:06 2025 +0200 Remove trailing dot after {@return …} because Javadoc already adds this dot. Before this commit, we had two dots at the end of summary sentences in the generated Javadoc. --- .../plugin/compiler/AbstractCompilerMojo.java | 41 +++++++++++----------- .../apache/maven/plugin/compiler/CompilerMojo.java | 18 +++++----- .../maven/plugin/compiler/DiagnosticLogger.java | 2 +- .../maven/plugin/compiler/IncrementalBuild.java | 2 +- .../maven/plugin/compiler/ModuleInfoPatch.java | 4 +-- .../org/apache/maven/plugin/compiler/Options.java | 2 +- .../apache/maven/plugin/compiler/PathFilter.java | 2 +- .../apache/maven/plugin/compiler/PathSelector.java | 6 ++-- .../maven/plugin/compiler/SourceDirectory.java | 10 +++--- .../apache/maven/plugin/compiler/SourceFile.java | 6 ++-- .../maven/plugin/compiler/SourcePathType.java | 8 ++--- .../maven/plugin/compiler/SourcesForRelease.java | 2 +- .../maven/plugin/compiler/TestCompilerMojo.java | 22 ++++++------ .../apache/maven/plugin/compiler/ToolExecutor.java | 4 +-- .../maven/plugin/compiler/ToolExecutorForTest.java | 2 +- .../plugin/compiler/WorkaroundForPatchModule.java | 2 +- .../maven/plugin/compiler/ModuleInfoPatchTest.java | 2 +- .../maven/plugin/compiler/stubs/CompilerStub.java | 27 +++++++------- .../plugin/compiler/stubs/FailingCompilerStub.java | 2 +- 19 files changed, 83 insertions(+), 81 deletions(-) diff --git a/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java b/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java index c65674c..a5be247 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java +++ b/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java @@ -134,7 +134,7 @@ public abstract class AbstractCompilerMojo implements Mojo { protected String encoding; /** - * {@return the character set used for decoding bytes, or null for the platform default}. + * {@return the character set used for decoding bytes, or null for the platform default} * No warning is emitted in the latter case because as of Java 18, the default is UTF-8, * i.e. the encoding is no longer platform-dependent. */ @@ -947,7 +947,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the inclusion filters for the compiler, or an empty list for all Java source files}. + * {@return the inclusion filters for the compiler, or an empty list for all Java source files} * The filter patterns are described in {@link java.nio.file.FileSystem#getPathMatcher(String)}. * If no syntax is specified, the default syntax is a derivative of "glob" compatible with the * behavior of Maven 3. @@ -955,7 +955,7 @@ public abstract class AbstractCompilerMojo implements Mojo { protected abstract Set<String> getIncludes(); /** - * {@return the exclusion filters for the compiler, or an empty list if none}. + * {@return the exclusion filters for the compiler, or an empty list if none} * The filter patterns are described in {@link java.nio.file.FileSystem#getPathMatcher(String)}. * If no syntax is specified, the default syntax is a derivative of "glob" compatible with the * behavior of Maven 3. @@ -963,7 +963,7 @@ public abstract class AbstractCompilerMojo implements Mojo { protected abstract Set<String> getExcludes(); /** - * {@return the exclusion filters for the incremental calculation}. + * {@return the exclusion filters for the incremental calculation} * Updated source files, if excluded by this filter, will not cause the project to be rebuilt. * * @see SourceFile#ignoreModification @@ -971,7 +971,7 @@ public abstract class AbstractCompilerMojo implements Mojo { protected abstract Set<String> getIncrementalExcludes(); /** - * {@return whether all includes/excludes matchers specified in the plugin configuration are empty}. + * {@return whether all includes/excludes matchers specified in the plugin configuration are empty} * This method checks only the plugin configuration. It does not check the {@code <source>} elements. */ final boolean hasNoFileMatchers() { @@ -981,14 +981,14 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the destination directory (or class output directory) for class files}. + * {@return the destination directory (or class output directory) for class files} * This directory will be given to the {@code -d} Java compiler option. */ @Nonnull protected abstract Path getOutputDirectory(); /** - * {@return the {@code --source} argument for the Java compiler}. + * {@return the {@code --source} argument for the Java compiler} * The default implementation returns the {@link #source} value. */ @Nullable @@ -997,7 +997,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the {@code --target} argument for the Java compiler}. + * {@return the {@code --target} argument for the Java compiler} * The default implementation returns the {@link #target} value. */ @Nullable @@ -1006,7 +1006,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the {@code --release} argument for the Java compiler}. + * {@return the {@code --release} argument for the Java compiler} * The default implementation returns the {@link #release} value. */ @Nullable @@ -1015,7 +1015,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the root directories of Java source code for the given scope}. + * {@return the root directories of Java source code for the given scope} * This method ignores the deprecated {@link #compileSourceRoots} element. * * @param scope whether to get the directories for main code or for the test code @@ -1025,7 +1025,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the root directories of the Java source files to compile, excluding empty directories}. + * {@return the root directories of the Java source files to compile, excluding empty directories} * The list needs to be modifiable for allowing the addition of generated source directories. * This is determined from the {@link #compileSourceRoots} plugin configuration if non-empty, * or from {@code <source>} elements otherwise. @@ -1044,7 +1044,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the path where to place generated source files created by annotation processing}. + * {@return the path where to place generated source files created by annotation processing} */ @Nullable protected abstract Path getGeneratedSourcesDirectory(); @@ -1072,7 +1072,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return whether the sources contain at least one {@code module-info.java} file}. + * {@return whether the sources contain at least one {@code module-info.java} file} * Note that the sources may contain more than one {@code module-info.java} file * if compiling a project with Module Source Hierarchy. * @@ -1101,7 +1101,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the file where to dump the command-line when debug logging is enabled or when the compilation failed}. + * {@return the file where to dump the command-line when debug logging is enabled or when the compilation failed} * For example, if the value is {@code "javac"}, then the Java compiler can be launched * from the command-line by typing {@code javac @target/javac.args}. * The debug file will contain the compiler options together with the list of source files to compile. @@ -1115,7 +1115,7 @@ public abstract class AbstractCompilerMojo implements Mojo { protected abstract String getDebugFileName(); /** - * {@return the debug file name with its path, or null if none}. + * {@return the debug file name with its path, or null if none} * This method does not check if the debug file will be written, as the compilation result is not yet known. */ final Path getDebugFilePath() { @@ -1222,7 +1222,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the compiler to use for compiling the code}. + * {@return the compiler to use for compiling the code} * If {@link #fork} is {@code true}, the returned compiler will be a wrapper for a command line. * Otherwise, it will be the compiler identified by {@link #compilerId} if a value was supplied, * or the standard compiler provided with the Java platform otherwise. @@ -1452,7 +1452,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return the tool chain specified by the user in plugin parameters}. + * {@return the tool chain specified by the user in plugin parameters} */ private Optional<Toolchain> getToolchain() { if (jdkToolchain != null) { @@ -1498,8 +1498,9 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return all dependencies grouped by the path types where to place them}. If the module-path contains - * any filename-based dependency and this MOJO is compiling the main code, then a warning will be logged. + * {@return all dependencies grouped by the path types where to place them} + * If the module-path contains any filename-based dependency and this <abbr>MOJO</abbr> + * is compiling the main code, then a warning will be logged. * * @param hasModuleDeclaration whether to allow placement of dependencies on the module-path. * @throws IOException if an I/O error occurred while fetching dependencies @@ -1606,7 +1607,7 @@ public abstract class AbstractCompilerMojo implements Mojo { } /** - * {@return whether an annotation processor seems to be present}. + * {@return whether an annotation processor seems to be present} * This method is invoked if the user did not specified explicit incremental compilation options. * * @param strict whether to be conservative if the current Java version is older than 23 diff --git a/src/main/java/org/apache/maven/plugin/compiler/CompilerMojo.java b/src/main/java/org/apache/maven/plugin/compiler/CompilerMojo.java index dcd7cb2..948eafa 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/CompilerMojo.java +++ b/src/main/java/org/apache/maven/plugin/compiler/CompilerMojo.java @@ -226,7 +226,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return the path where to place generated source files created by annotation processing on the main classes}. + * {@return the path where to place generated source files created by annotation processing on the main classes} */ @Nullable @Override @@ -235,7 +235,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return the inclusion filters for the compiler, or an empty set for all Java source files}. + * {@return the inclusion filters for the compiler, or an empty set for all Java source files} */ @Override protected Set<String> getIncludes() { @@ -243,7 +243,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return the exclusion filters for the compiler, or an empty set if none}. + * {@return the exclusion filters for the compiler, or an empty set if none} */ @Override protected Set<String> getExcludes() { @@ -251,7 +251,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return the exclusion filters for the incremental calculation, or an empty set if none}. + * {@return the exclusion filters for the incremental calculation, or an empty set if none} */ @Override protected Set<String> getIncrementalExcludes() { @@ -259,7 +259,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return the destination directory for main class files}. + * {@return the destination directory for main class files} * If {@link #multiReleaseOutput} is true <em>(deprecated)</em>, * the output will be in a {@code META-INF/versions} subdirectory. */ @@ -273,7 +273,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return the file where to dump the command-line when debug is activated or when the compilation failed}. + * {@return the file where to dump the command-line when debug is activated or when the compilation failed} * * @see #debugFileName */ @@ -301,7 +301,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return whether the project has at least one module-info file}. + * {@return whether the project has at least one module-info file} * If no such file is found in the code to be compiled by this <abbr>MOJO</abbr> execution, * then this method searches in the multi-release codes compiled by previous executions. * @@ -330,7 +330,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return the output directory of each target Java version}. + * {@return the output directory of each target Java version} * By convention, {@link SourceVersion#RELEASE_0} stands for the base version. * * @throws IOException if this method needs to walk through directories and that operation failed @@ -437,7 +437,7 @@ public class CompilerMojo extends AbstractCompilerMojo { } /** - * {@return the module name in a previous execution of the compiler plugin, or {@code null} if none}. + * {@return the module name in a previous execution of the compiler plugin, or {@code null} if none} * * @deprecated For compatibility with the previous way to build multi-release JAR file. * May be removed after we drop support of the old way to do multi-release. diff --git a/src/main/java/org/apache/maven/plugin/compiler/DiagnosticLogger.java b/src/main/java/org/apache/maven/plugin/compiler/DiagnosticLogger.java index 9af2e3f..bc588c7 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/DiagnosticLogger.java +++ b/src/main/java/org/apache/maven/plugin/compiler/DiagnosticLogger.java @@ -217,7 +217,7 @@ final class DiagnosticLogger implements DiagnosticListener<JavaFileObject> { } /** - * {@return the pattern for formatting the specified number followed by a label}. + * {@return the pattern for formatting the specified number followed by a label} * The given number should be the widest number to format. * A margin of 4 spaces is added at the beginning of the line. */ diff --git a/src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java b/src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java index 4de2486..a1f60a4 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java +++ b/src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java @@ -772,7 +772,7 @@ final class IncrementalBuild { } /** - * {@return whether the given list of modified files should not cause a recompilation}. + * {@return whether the given list of modified files should not cause a recompilation} * This method returns {@code true} if the given list is empty or contains only files * with the {@link SourceFile#ignoreModification} set to {@code true}. * diff --git a/src/main/java/org/apache/maven/plugin/compiler/ModuleInfoPatch.java b/src/main/java/org/apache/maven/plugin/compiler/ModuleInfoPatch.java index e2c3b3d..6656700 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ModuleInfoPatch.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ModuleInfoPatch.java @@ -372,7 +372,7 @@ final class ModuleInfoPatch { } /** - * {@return the set of modules associated to the given package name}. + * {@return the set of modules associated to the given package name} * * @param target the map where to store the set of modules * @param packageName the package name for which to get a set of modules @@ -581,7 +581,7 @@ final class ModuleInfoPatch { } /** - * {@return the name of the module to patch, or null if unspecified and no default}. + * {@return the name of the module to patch, or null if unspecified and no default} */ public String getModuleName() { return moduleName; diff --git a/src/main/java/org/apache/maven/plugin/compiler/Options.java b/src/main/java/org/apache/maven/plugin/compiler/Options.java index 58b778c..25d5801 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/Options.java +++ b/src/main/java/org/apache/maven/plugin/compiler/Options.java @@ -418,7 +418,7 @@ public final class Options { } /** - * {@return a string representatation of the options for debugging purposes}. + * {@return a string representatation of the options for debugging purposes} */ @Override public String toString() { diff --git a/src/main/java/org/apache/maven/plugin/compiler/PathFilter.java b/src/main/java/org/apache/maven/plugin/compiler/PathFilter.java index 7f1995d..3d1de95 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/PathFilter.java +++ b/src/main/java/org/apache/maven/plugin/compiler/PathFilter.java @@ -157,7 +157,7 @@ final class PathFilter extends SimpleFileVisitor<Path> { } /** - * {@return all source files found in the given root directories}. + * {@return all source files found in the given root directories} * The include and exclude filters specified at construction time are applied. * Hidden directories are ignored, and symbolic links are followed. * diff --git a/src/main/java/org/apache/maven/plugin/compiler/PathSelector.java b/src/main/java/org/apache/maven/plugin/compiler/PathSelector.java index 509bfde..748d384 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/PathSelector.java +++ b/src/main/java/org/apache/maven/plugin/compiler/PathSelector.java @@ -473,7 +473,7 @@ final class PathSelector implements PathMatcher { } /** - * {@return a potentially simpler matcher equivalent to this matcher}. + * {@return a potentially simpler matcher equivalent to this matcher} */ @SuppressWarnings("checkstyle:MissingSwitchDefault") public PathMatcher simplify() { @@ -505,7 +505,7 @@ final class PathSelector implements PathMatcher { } /** - * {@return whether the given file matches according to one of the given matchers}. + * {@return whether the given file matches according to one of the given matchers} */ private static boolean isMatched(Path path, PathMatcher[] matchers) { for (PathMatcher matcher : matchers) { @@ -554,7 +554,7 @@ final class PathSelector implements PathMatcher { } /** - * {@return a string representation for logging purposes}. + * {@return a string representation for logging purposes} */ @Override public String toString() { diff --git a/src/main/java/org/apache/maven/plugin/compiler/SourceDirectory.java b/src/main/java/org/apache/maven/plugin/compiler/SourceDirectory.java index e89c01f..45f0505 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/SourceDirectory.java +++ b/src/main/java/org/apache/maven/plugin/compiler/SourceDirectory.java @@ -233,7 +233,7 @@ final class SourceDirectory { } /** - * {@return the target version as an object from the Java tools API}. + * {@return the target version as an object from the Java tools API} * * @param root the source directory for which to get the target version * @throws UnsupportedVersionException if the version string cannot be parsed @@ -368,7 +368,7 @@ final class SourceDirectory { } /** - * {@return the Java version of the sources in this directory if different than the base version}. + * {@return the Java version of the sources in this directory if different than the base version} * The value returned by this method is related to the {@code META-INF/versions/} subdirectory in * the path returned by {@link #getOutputDirectory()}. If this method returns an empty value, then * there is no such subdirectory (which doesn't mean that the user did not specified a Java version). @@ -379,7 +379,7 @@ final class SourceDirectory { } /** - * {@return the directory where to store the compilation results}. + * {@return the directory where to store the compilation results} * This is the <abbr>MOJO</abbr> output directory potentially completed with * sub-directories for module name and {@code META-INF/versions} versioning. */ @@ -409,7 +409,7 @@ final class SourceDirectory { } /** - * {@return a hash code value for this root directory}. + * {@return a hash code value for this root directory} */ @Override public int hashCode() { @@ -417,7 +417,7 @@ final class SourceDirectory { } /** - * {@return a string representation of this root directory for debugging purposes}. + * {@return a string representation of this root directory for debugging purposes} */ @Override public String toString() { diff --git a/src/main/java/org/apache/maven/plugin/compiler/SourceFile.java b/src/main/java/org/apache/maven/plugin/compiler/SourceFile.java index 87a4ee2..5f299a0 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/SourceFile.java +++ b/src/main/java/org/apache/maven/plugin/compiler/SourceFile.java @@ -89,7 +89,7 @@ final class SourceFile { } /** - * {@return whether the output file is the same as the one that we would infer from heuristic rules}. + * {@return whether the output file is the same as the one that we would infer from heuristic rules} * * <p>TODO: this is not yet implemented. We need to clarify how to get the output file information * from the compiler, maybe via the {@link javax.tools.JavaFileManager#getFileForOutput} method. @@ -164,7 +164,7 @@ final class SourceFile { } /** - * {@return a hash code value for this file}. + * {@return a hash code value for this file} */ @Override public int hashCode() { @@ -172,7 +172,7 @@ final class SourceFile { } /** - * {@return a string representation of this source file for debugging purposes}. + * {@return a string representation of this source file for debugging purposes} * This string representation is shown in Maven output if debug logs are enabled. */ @Override diff --git a/src/main/java/org/apache/maven/plugin/compiler/SourcePathType.java b/src/main/java/org/apache/maven/plugin/compiler/SourcePathType.java index 547920f..8231d72 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/SourcePathType.java +++ b/src/main/java/org/apache/maven/plugin/compiler/SourcePathType.java @@ -96,7 +96,7 @@ final class SourcePathType implements PathType { } /** - * {@return the option followed by a string representation of the given path elements}. + * {@return the option followed by a string representation of the given path elements} * * @param paths the path elements to format */ @@ -108,7 +108,7 @@ final class SourcePathType implements PathType { } /** - * {@return a hash code value based on the module name}. + * {@return a hash code value based on the module name} */ @Override public int hashCode() { @@ -116,7 +116,7 @@ final class SourcePathType implements PathType { } /** - * {@return whether the given object represents the same source path as this object}. + * {@return whether the given object represents the same source path as this object} */ @Override public boolean equals(Object obj) { @@ -124,7 +124,7 @@ final class SourcePathType implements PathType { } /** - * {@return a string representation for debugging purposes}. + * {@return a string representation for debugging purposes} */ @Override public String toString() { diff --git a/src/main/java/org/apache/maven/plugin/compiler/SourcesForRelease.java b/src/main/java/org/apache/maven/plugin/compiler/SourcesForRelease.java index 0778381..8c11390 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/SourcesForRelease.java +++ b/src/main/java/org/apache/maven/plugin/compiler/SourcesForRelease.java @@ -191,7 +191,7 @@ final class SourcesForRelease implements Closeable { } /** - * {@return a string representation for debugging purposes}. + * {@return a string representation for debugging purposes} */ @Override public String toString() { diff --git a/src/main/java/org/apache/maven/plugin/compiler/TestCompilerMojo.java b/src/main/java/org/apache/maven/plugin/compiler/TestCompilerMojo.java index afcbc00..441c745 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/TestCompilerMojo.java +++ b/src/main/java/org/apache/maven/plugin/compiler/TestCompilerMojo.java @@ -280,7 +280,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { } /** - * {@return the path where to place generated source files created by annotation processing on the test classes}. + * {@return the path where to place generated source files created by annotation processing on the test classes} */ @Nullable @Override @@ -289,7 +289,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { } /** - * {@return the inclusion filters for the compiler, or an empty set for all Java source files}. + * {@return the inclusion filters for the compiler, or an empty set for all Java source files} */ @Override protected Set<String> getIncludes() { @@ -297,7 +297,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { } /** - * {@return the exclusion filters for the compiler, or an empty set if none}. + * {@return the exclusion filters for the compiler, or an empty set if none} */ @Override protected Set<String> getExcludes() { @@ -305,7 +305,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { } /** - * {@return the exclusion filters for the incremental calculation, or an empty set if none}. + * {@return the exclusion filters for the incremental calculation, or an empty set if none} */ @Override protected Set<String> getIncrementalExcludes() { @@ -349,7 +349,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { } /** - * {@return the destination directory for test class files}. + * {@return the destination directory for test class files} */ @Nonnull @Override @@ -358,7 +358,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { } /** - * {@return the file where to dump the command-line when debug is activated or when the compilation failed}. + * {@return the file where to dump the command-line when debug is activated or when the compilation failed} * * @see #debugFileName */ @@ -369,10 +369,10 @@ public class TestCompilerMojo extends AbstractCompilerMojo { } /** - * {@return the module name declared in the test sources}. We have to parse the source instead - * of the {@code module-info.class} file because the classes may not have been compiled yet. - * This is not very reliable, but putting a {@code module-info.java} file in the tests is - * deprecated anyway. + * {@return the module name declared in the test sources} + * We have to parse the source instead of the {@code module-info.class} file + * because the classes may not have been compiled yet. + * This is not very reliable, but putting a {@code module-info.java} file in the tests is deprecated anyway. */ final String getTestModuleName(List<SourceDirectory> compileSourceRoots) throws IOException { for (SourceDirectory directory : compileSourceRoots) { @@ -388,7 +388,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { } /** - * {@return whether the project has at least one {@code module-info.class} file}. + * {@return whether the project has at least one {@code module-info.class} file} * * @param roots root directories of the sources to compile * @throws IOException if this method needed to read a module descriptor and failed diff --git a/src/main/java/org/apache/maven/plugin/compiler/ToolExecutor.java b/src/main/java/org/apache/maven/plugin/compiler/ToolExecutor.java index ec3c521..25abc68 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ToolExecutor.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ToolExecutor.java @@ -278,7 +278,7 @@ public class ToolExecutor { } /** - * {@return whether a release version is specified for all sources}. + * {@return whether a release version is specified for all sources} */ final boolean isReleaseSpecifiedForAll() { for (SourceDirectory source : sourceDirectories) { @@ -360,7 +360,7 @@ public class ToolExecutor { } /** - * {@return a modifiable list of paths to all dependencies of the given type}. + * {@return a modifiable list of paths to all dependencies of the given type} * The returned list is intentionally live: elements can be added or removed * from the list for changing the state of this executor. * diff --git a/src/main/java/org/apache/maven/plugin/compiler/ToolExecutorForTest.java b/src/main/java/org/apache/maven/plugin/compiler/ToolExecutorForTest.java index 2c0fc91..0eba178 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ToolExecutorForTest.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ToolExecutorForTest.java @@ -209,7 +209,7 @@ class ToolExecutorForTest extends ToolExecutor { } /** - * {@return the module name of the main code, or an empty string if none}. + * {@return the module name of the main code, or an empty string if none} * This method reads the module descriptor when first needed and caches the result. * This used if the user did not specified an explicit {@code <module>} element in the sources. * diff --git a/src/main/java/org/apache/maven/plugin/compiler/WorkaroundForPatchModule.java b/src/main/java/org/apache/maven/plugin/compiler/WorkaroundForPatchModule.java index a290991..1f62ae4 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/WorkaroundForPatchModule.java +++ b/src/main/java/org/apache/maven/plugin/compiler/WorkaroundForPatchModule.java @@ -88,7 +88,7 @@ final class WorkaroundForPatchModule extends ForwardingJavaFileManager<StandardJ } /** - * {@return the original file manager, or {@code null} if the caller needs to create a new one}. + * {@return the original file manager, or {@code null} if the caller needs to create a new one} * The returned value is {@code null} when we have been unable to set a {@code --patch-module} * option on the current file manager. In such case, the caller should create a new file manager * and configure it with {@link #copyTo(StandardJavaFileManager)}. diff --git a/src/test/java/org/apache/maven/plugin/compiler/ModuleInfoPatchTest.java b/src/test/java/org/apache/maven/plugin/compiler/ModuleInfoPatchTest.java index 3d17e3a..4cefde2 100644 --- a/src/test/java/org/apache/maven/plugin/compiler/ModuleInfoPatchTest.java +++ b/src/test/java/org/apache/maven/plugin/compiler/ModuleInfoPatchTest.java @@ -83,7 +83,7 @@ public class ModuleInfoPatchTest implements OptionChecker { } /** - * {@return the number of arguments the given option takes}. + * {@return the number of arguments the given option takes} * * @param option an option */ diff --git a/src/test/java/org/apache/maven/plugin/compiler/stubs/CompilerStub.java b/src/test/java/org/apache/maven/plugin/compiler/stubs/CompilerStub.java index dd14a81..d5aae6d 100644 --- a/src/test/java/org/apache/maven/plugin/compiler/stubs/CompilerStub.java +++ b/src/test/java/org/apache/maven/plugin/compiler/stubs/CompilerStub.java @@ -93,7 +93,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { public CompilerStub() {} /** - * {@return the compiler idenitifer of this stub}. + * {@return the compiler idenitifer of this stub} */ @Override public String name() { @@ -101,7 +101,8 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return an arbitrary Java release number}. This is not used by the tests. + * {@return an arbitrary Java release number} + * This is not used by the tests. */ @Override public Set<SourceVersion> getSourceVersions() { @@ -109,7 +110,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return the number of arguments expected by the given option}. + * {@return the number of arguments expected by the given option} * This method is implemented by a hard-coded list of options that * are known to be used in some tests. */ @@ -127,7 +128,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return the object where source and destination directories will be specified by the Maven compiler plugin}. + * {@return the object where source and destination directories will be specified by the Maven compiler plugin} */ @Override public StandardJavaFileManager getStandardFileManager( @@ -136,7 +137,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return whether the two given objects are for the same file}. + * {@return whether the two given objects are for the same file} * This method is not seriously implemented, as it is not needed for the tests. */ @Override @@ -159,7 +160,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return the given files or directories wrapped in a dummy implementation of {@code FileObject}}. + * {@return the given files or directories wrapped in a dummy implementation of {@code FileObject}} */ @Override public Iterable<? extends JavaFileObject> getJavaFileObjectsFromFiles(Iterable<? extends File> files) { @@ -169,7 +170,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return the given files or directories wrapped in a dummy implementation of {@code FileObject}}. + * {@return the given files or directories wrapped in a dummy implementation of {@code FileObject}} */ @Override public Iterable<? extends JavaFileObject> getJavaFileObjects(File... files) { @@ -177,7 +178,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return the given files or directories wrapped in a dummy implementation of {@code FileObject}}. + * {@return the given files or directories wrapped in a dummy implementation of {@code FileObject}} */ @Override public Iterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names) { @@ -187,7 +188,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return the given files or directories wrapped in a dummy implementation of {@code FileObject}}. + * {@return the given files or directories wrapped in a dummy implementation of {@code FileObject}} */ @Override public Iterable<? extends JavaFileObject> getJavaFileObjects(String... names) { @@ -195,7 +196,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return whether the given location is known to this file manager}. + * {@return whether the given location is known to this file manager} */ @Override public boolean hasLocation(Location location) { @@ -221,7 +222,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return the directory for the given type of location}. + * {@return the directory for the given type of location} */ @Override public Iterable<? extends File> getLocation(Location location) { @@ -298,7 +299,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return a compilation task}. + * {@return a compilation task} */ @Override public CompilationTask getTask( @@ -350,7 +351,7 @@ public class CompilerStub implements JavaCompiler, StandardJavaFileManager { } /** - * {@return the options given to the compiler when the compilation tasks was created}. + * {@return the options given to the compiler when the compilation tasks was created} */ public static List<String> getOptions() { var options = new ArrayList<String>(); diff --git a/src/test/java/org/apache/maven/plugin/compiler/stubs/FailingCompilerStub.java b/src/test/java/org/apache/maven/plugin/compiler/stubs/FailingCompilerStub.java index 64b75e1..b37cd9e 100644 --- a/src/test/java/org/apache/maven/plugin/compiler/stubs/FailingCompilerStub.java +++ b/src/test/java/org/apache/maven/plugin/compiler/stubs/FailingCompilerStub.java @@ -45,7 +45,7 @@ public class FailingCompilerStub extends CompilerStub { public FailingCompilerStub() {} /** - * {@return the compiler idenitifer of this stub}. + * {@return the compiler idenitifer of this stub} */ @Override public String name() {
