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 c2f7a50fe..8d26f9b7d 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java +++ b/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java @@ -228,7 +228,7 @@ final Charset charset() { * If non-empty, the project {@code } elements are ignored. This configuration option * should be used only when there is a need to override the project configuration. * - * @deprecated Replaced by the project-wide {@code } element. + * @deprecated replaced by the project-wide {@code } element */ @Parameter @Deprecated(since = "4.0.0") @@ -270,8 +270,7 @@ final Charset charset() { *

Note that {@code -J} options should be specified only if {@link #fork} is set to {@code true}.

* * @see javac -J - * - * @deprecated Use {@link #compilerArgs} instead. + * @deprecated use {@link #compilerArgs} instead */ @Parameter @Deprecated(since = "4.0.0") @@ -354,9 +353,8 @@ final Charset charset() { * @see javac -processorpath * @see javac Annotation Processing * @since 3.5 - * - * @deprecated Replaced by ordinary dependencies with {@code } element set to - * {@code processor}, {@code classpath-processor} or {@code modular-processor}. + * @deprecated replaced by ordinary dependencies with {@code } element set to + * {@code processor}, {@code classpath-processor} or {@code modular-processor} */ @Parameter @Deprecated(since = "4.0.0") @@ -372,8 +370,7 @@ final Charset charset() { *

* * @since 3.12.0 - * - * @deprecated This flag is ignored. + * @deprecated this flag is ignored. * Replaced by ordinary dependencies with {@code } element set to * {@code processor}, {@code classpath-processor} or {@code modular-processor}. */ @@ -432,8 +429,7 @@ final Charset charset() { * * @see #debuglevel * @see javac -g - * - * @deprecated Setting this flag to {@code false} is replaced by {@code none}. + * @deprecated setting this flag to {@code false} is replaced by {@code none} */ @Deprecated(since = "4.0.0") @Parameter(property = "maven.compiler.debug", defaultValue = "true") @@ -462,7 +458,8 @@ final Charset charset() { /** * Whether to optimize the compiled code using the compiler's optimization methods. - * @deprecated This property is ignored. + * + * @deprecated this property is ignored */ @Deprecated(forRemoval = true) @Parameter(property = "maven.compiler.optimize") @@ -533,7 +530,7 @@ final Charset charset() { * *

expression="${project.build.finalName}"

* - * @deprecated Bundling many class files into a single file should be done by other plugins. + * @deprecated bundling many class files into a single file should be done by other plugins */ @Parameter @Deprecated(since = "4.0.0", forRemoval = true) @@ -545,8 +542,7 @@ final Charset charset() { * SOURCE_DATE_EPOCH). * * @since 3.12.0 - * - * @deprecated Not used by the compiler plugin since it does not generate archive. + * @deprecated not used by the compiler plugin since it does not generate archive */ @Deprecated(since = "4.0.0", forRemoval = true) @Parameter(defaultValue = "${project.build.outputTimestamp}") @@ -630,8 +626,7 @@ final Charset charset() { * Whether to enable/disable incremental compilation feature. * * @since 3.1 - * - * @deprecated Replaced by {@link #incrementalCompilation}. + * @deprecated replaced by {@link #incrementalCompilation}. * A value of {@code true} in this old property is equivalent to {@code "dependencies,sources,rebuild-on-add"} * in the new property, and a value of {@code false} is equivalent to {@code "classes"}. */ @@ -753,9 +748,8 @@ final EnumSet incrementalCompilationConfiguration() { * Version of the compiler to use if {@link #fork} is set to {@code true}. * Examples! "1.3", "1.5". * - * @deprecated This parameter is no longer used by the underlying compilers. - * * @see #fork + * @deprecated this parameter is no longer used by the underlying compilers */ @Deprecated(since = "4.0.0", forRemoval = true) @Parameter(property = "maven.compiler.compilerVersion") @@ -767,8 +761,7 @@ final EnumSet incrementalCompilationConfiguration() { * @see New API * @see Legacy API * @since 3.13 - * - * @deprecated Ignored because the compiler plugin now always use the {@code javax.tools} API. + * @deprecated ignored because the compiler plugin now always use the {@code javax.tools} API */ @Deprecated(since = "4.0.0", forRemoval = true) @Parameter(property = "maven.compiler.forceLegacyJavacApi") @@ -778,8 +771,7 @@ final EnumSet incrementalCompilationConfiguration() { * Whether to use legacy compiler API. * * @since 3.0 - * - * @deprecated Ignored because {@code java.lang.Compiler} has been deprecated and removed from the JDK. + * @deprecated ignored because {@code java.lang.Compiler} has been deprecated and removed from the JDK */ @Deprecated(since = "4.0.0", forRemoval = true) @Parameter(property = "maven.compiler.forceJavacCompilerUse") @@ -797,8 +789,7 @@ final EnumSet incrementalCompilationConfiguration() { * Note this parameter value depends on the OS/JDK you are using, but the default value should work on most of env. * * @since 2.5 - * - * @deprecated Not supported anymore. The reuse of {@link JavaFileManager} instance is plugin implementation details. + * @deprecated not supported anymore. The reuse of {@link JavaFileManager} instance is plugin implementation details. */ @Deprecated(since = "4.0.0", forRemoval = true) @Parameter(property = "maven.compiler.compilerReuseStrategy") @@ -806,8 +797,7 @@ final EnumSet incrementalCompilationConfiguration() { /** * @since 2.5 - * - * @deprecated Deprecated as a consequence of {@link #compilerReuseStrategy} deprecation. + * @deprecated deprecated as a consequence of {@link #compilerReuseStrategy} deprecation */ @Deprecated(since = "4.0.0", forRemoval = true) @Parameter(property = "maven.compiler.skipMultiThreadWarning") @@ -860,7 +850,7 @@ final EnumSet incrementalCompilationConfiguration() { * Path to a file where to cache information about the last incremental build. * This is used when "incremental" builds are enabled for detecting additions * or removals of source files, or changes in plugin configuration. - * This file should be in the output directory and can be deleted at any time + * This file should be in the output directory and can be deleted at any time. */ @Parameter( defaultValue = @@ -1048,10 +1038,8 @@ final List getSourceDirectories(final Path outputDirectory) thr * * @return the module name in a previous execution of the compiler plugin, or {@code null} if none * @throws IOException if this method needs to walk through directories and that operation failed - * * @see CompilerMojo#addImplicitDependencies(ToolExecutor) - * - * @deprecated For compatibility with the previous way to build multi-release JAR file. + * @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. */ @Deprecated(since = "4.0.0") @@ -1172,9 +1160,9 @@ public void execute() throws MojoException { * * @param listener where to send compilation warnings, or {@code null} for the Maven logger * @return the task to execute for compiling the project using the configuration in this MOJO - * @throws MojoException if this method identifies an invalid parameter in this MOJO * @throws IOException if an error occurred while creating the output directory or scanning the source directories * @throws MavenException if an error occurred while fetching dependencies + * @throws MojoException if this method identifies an invalid parameter in this MOJO */ public ToolExecutor createExecutor(DiagnosticListener listener) throws IOException { var executor = new ToolExecutor(this, listener); @@ -1255,7 +1243,7 @@ public JavaCompiler compiler() throws MojoException { * The {@link #release} parameter is excluded because it is handled in a special way * in order to support the compilation of multi-version projects. * - * @param compiler the tools to use for verifying the validity of options + * @param compiler the tools to use for verifying the validity of options * @return the options after validation */ public Options parseParameters(final OptionChecker compiler) { @@ -1467,9 +1455,9 @@ final String parseModuleInfoName(Path source) throws IOException { * {@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. * - * @param hasModuleDeclaration whether to allow placement of dependencies on the module-path. + * @param hasModuleDeclaration whether to allow placement of dependencies on the module-path * @throws IOException if an I/O error occurred while fetching dependencies - * @throws MavenException if an error occurred while fetching dependencies for a reason other than I/O. + * @throws MavenException if an error occurred while fetching dependencies for a reason other than I/O */ final DependencyResolverResult resolveDependencies(boolean hasModuleDeclaration) throws IOException { DependencyResolver resolver = session.getService(DependencyResolver.class); @@ -1531,9 +1519,8 @@ final DependencyResolverResult resolveDependencies(boolean hasModuleDeclaration) * * @param addTo the modifiable map and lists where to append more paths to annotation processor dependencies * @throws MojoException if an error occurred while resolving the dependencies - * - * @deprecated Replaced by ordinary dependencies with {@code } element set to - * {@code processor}, {@code classpath-processor} or {@code modular-processor}. + * @deprecated replaced by ordinary dependencies with {@code } element set to + * {@code processor}, {@code classpath-processor} or {@code modular-processor} */ @Deprecated(since = "4.0.0") final void resolveProcessorPathEntries(Map> addTo) throws MojoException { @@ -1760,7 +1747,7 @@ private void writeDebugFile(final ToolExecutor executor, final Options configura * The check for the project directory tree (starting from the root of all sub-projects) is for avoiding * to relativize the paths to JAR files in the Maven local repository for example. * - * @param file the path to make relative to the base directory + * @param file the path to make relative to the base directory * @return the given path, potentially relative to the base directory */ private Path relativize(Path file) { diff --git a/src/main/java/org/apache/maven/plugin/compiler/ByteCodeTransformer.java b/src/main/java/org/apache/maven/plugin/compiler/ByteCodeTransformer.java index 749813182..ff00dc343 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ByteCodeTransformer.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ByteCodeTransformer.java @@ -54,7 +54,6 @@ private ByteCodeTransformer() {} * * @param originalBytecode the byte code to patch * @return the patched byte code, or {@code null} if no change is needed - * * @see MCOMPILER-542 * @see JDK-8318913 * @see #MODULE_VERSION_FIX diff --git a/src/main/java/org/apache/maven/plugin/compiler/CompilationTaskSources.java b/src/main/java/org/apache/maven/plugin/compiler/CompilationTaskSources.java index 69146a762..9991bec1c 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/CompilationTaskSources.java +++ b/src/main/java/org/apache/maven/plugin/compiler/CompilationTaskSources.java @@ -37,7 +37,7 @@ class CompilationTaskSources { /** * Creates a new compilation task. * - * @param files the files to compile. + * @param files the files to compile */ CompilationTaskSources(List files) { this.files = files; @@ -47,9 +47,9 @@ class CompilationTaskSources { * Executes the compilation task. Subclasses can override this method is they need to perform * pre-compilation or post-compilation tasks. * - * @param task the compilation task - * @return whether the compilation was successful. - * @throws IOException if an initialization or cleaner task was required and failed. + * @param task the compilation task + * @return whether the compilation was successful + * @throws IOException if an initialization or cleaner task was required and failed */ boolean compile(JavaCompiler.CompilationTask task) throws IOException { return task.call(); 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 0127d8633..8430aea98 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/CompilerMojo.java +++ b/src/main/java/org/apache/maven/plugin/compiler/CompilerMojo.java @@ -124,8 +124,7 @@ public class CompilerMojo extends AbstractCompilerMojo { *

* * @since 3.7.1 - * - * @deprecated Replaced by specifying the {@code } value inside a {@code } element. + * @deprecated replaced by specifying the {@code } value inside a {@code } element */ @Parameter @Deprecated(since = "4.0.0") @@ -164,7 +163,7 @@ public class CompilerMojo extends AbstractCompilerMojo { * When using the recommended {@code } approach, the plugins are designed to work * with the directory layout produced by {@code javac} instead of fighting against it. * - * @deprecated For compatibility with the previous way to build multi-release JAR file. + * @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. */ @Deprecated(since = "4.0.0") @@ -182,7 +181,7 @@ public CompilerMojo() { * If {@link #skipMain} is {@code true}, then this method logs a message and does nothing else. * Otherwise, this method executes the steps described in the method of the parent class. * - * @throws MojoException if the compiler cannot be run. + * @throws MojoException if the compiler cannot be run */ @Override public void execute() throws MojoException { @@ -209,7 +208,7 @@ public void execute() throws MojoException { /** * Parses the parameters declared in the MOJO. * - * @param compiler the tools to use for verifying the validity of options + * @param compiler the tools to use for verifying the validity of options * @return the options after validation */ @Override @@ -281,9 +280,9 @@ protected String getDebugFileName() { * Creates a new task for compiling the main classes. * * @param listener where to send compilation warnings, or {@code null} for the Maven logger - * @throws MojoException if this method identifies an invalid parameter in this MOJO * @return the task to execute for compiling the main code using the configuration in this MOJO * @throws IOException if an error occurred while creating the output directory or scanning the source directories + * @throws MojoException if this method identifies an invalid parameter in this MOJO */ @Override public ToolExecutor createExecutor(DiagnosticListener listener) throws IOException { @@ -301,8 +300,7 @@ public ToolExecutor createExecutor(DiagnosticListener li * * @param roots root directories of the sources to compile * @throws IOException if this method needed to read a module descriptor and failed - * - * @deprecated For compatibility with the previous way to build multi-release JAR file. + * @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. */ @Override @@ -328,8 +326,7 @@ final boolean hasModuleDeclaration(final List roots) throws IOE * 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 - * - * @deprecated For compatibility with the previous way to build multi-release JAR file. + * @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. */ @Deprecated(since = "4.0.0") @@ -367,11 +364,10 @@ private TreeMap getOutputDirectoryPerVersion() throws IOExc * module name, with no executor to modify. The module name found by this method is specific to * the way that projects are organized when {@link #multiReleaseOutput} is {@code true}.

* - * @param executor the executor where to add implicit dependencies, or {@code null} if none + * @param executor the executor where to add implicit dependencies, or {@code null} if none * @return the module name, or {@code null} if none * @throws IOException if this method needs to walk through directories and that operation failed - * - * @deprecated For compatibility with the previous way to build multi-release JAR file. + * @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. */ @Deprecated(since = "4.0.0") @@ -433,7 +429,7 @@ private String addImplicitDependencies(final ToolExecutor executor) throws IOExc /** * {@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. + * @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. */ @Override diff --git a/src/main/java/org/apache/maven/plugin/compiler/DependencyCoordinate.java b/src/main/java/org/apache/maven/plugin/compiler/DependencyCoordinate.java index bbc52ea5f..cd291a61c 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/DependencyCoordinate.java +++ b/src/main/java/org/apache/maven/plugin/compiler/DependencyCoordinate.java @@ -36,8 +36,7 @@ * * @author Andreas Gudian * @since 3.4 - * - * @deprecated Used for {@link AbstractCompilerMojo#annotationProcessorPaths}, which is deprecated. + * @deprecated used for {@link AbstractCompilerMojo#annotationProcessorPaths}, which is deprecated */ @Deprecated(since = "4.0.0") public final class DependencyCoordinate { diff --git a/src/main/java/org/apache/maven/plugin/compiler/DependencyExclusion.java b/src/main/java/org/apache/maven/plugin/compiler/DependencyExclusion.java index 6a321f139..82b872c4e 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/DependencyExclusion.java +++ b/src/main/java/org/apache/maven/plugin/compiler/DependencyExclusion.java @@ -23,7 +23,7 @@ /** * Simple representation of a Maven dependency exclusion. * - * @deprecated Used for {@link AbstractCompilerMojo#annotationProcessorPaths}, which is deprecated. + * @deprecated used for {@link AbstractCompilerMojo#annotationProcessorPaths}, which is deprecated */ @Deprecated(since = "4.0.0") public final class DependencyExclusion { 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 9af2e3fb9..9a99b3eb8 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/DiagnosticLogger.java +++ b/src/main/java/org/apache/maven/plugin/compiler/DiagnosticLogger.java @@ -93,7 +93,7 @@ final class DiagnosticLogger implements DiagnosticListener { /** * Makes the given file relative to the base directory. * - * @param file the path to make relative to the base directory + * @param file the path to make relative to the base directory * @return the given path, potentially relative to the base directory */ private String relativize(String file) { diff --git a/src/main/java/org/apache/maven/plugin/compiler/ForkedCompiler.java b/src/main/java/org/apache/maven/plugin/compiler/ForkedCompiler.java index 07b2d2c92..444c56d01 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ForkedCompiler.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ForkedCompiler.java @@ -38,7 +38,7 @@ final class ForkedCompiler extends ForkedTool implements JavaCompiler { /** * Creates a new forked compiler. * - * @param mojo the MOJO from which to get the configuration + * @param mojo the MOJO from which to get the configuration */ ForkedCompiler(final AbstractCompilerMojo mojo) { super(mojo); diff --git a/src/main/java/org/apache/maven/plugin/compiler/ForkedTool.java b/src/main/java/org/apache/maven/plugin/compiler/ForkedTool.java index 1a774a590..6e18c8fba 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ForkedTool.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ForkedTool.java @@ -65,7 +65,7 @@ class ForkedTool implements Tool, OptionChecker { /** * Creates a new forked compiler. * - * @param mojo the MOJO from which to get the configuration + * @param mojo the MOJO from which to get the configuration */ ForkedTool(final AbstractCompilerMojo mojo) { basedir = mojo.basedir; diff --git a/src/main/java/org/apache/maven/plugin/compiler/ForkedToolSources.java b/src/main/java/org/apache/maven/plugin/compiler/ForkedToolSources.java index c34bd3587..d342e9c14 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ForkedToolSources.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ForkedToolSources.java @@ -55,7 +55,6 @@ * Source files for a call to {@code javac} or {@code javadoc} command to be executed as a separated process. * * @author Martin Desruisseaux - * * @see ForkedCompiler */ final class ForkedToolSources implements StandardJavaFileManager { 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 5e3083ba3..425021a80 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java +++ b/src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java @@ -534,7 +534,6 @@ void deleteClassFiles(final Path sourceFile) throws IOException { * * @return {@code null} if the project does not need to be rebuilt, otherwise a message saying why to rebuild * @throws IOException if an error occurred while deleting output files of the previous build - * * @see Aspect#SOURCES */ String inputFileTreeChanges() throws IOException { @@ -629,7 +628,6 @@ String inputFileTreeChanges() throws IOException { * @param changeTime the time at which a file is considered as changed * @return {@code null} if the project does not need to be rebuilt, otherwise a message saying why to rebuild * @throws IOException if an error occurred while scanning the directories - * * @see Aspect#DEPENDENCIES */ String dependencyChanges(Iterable> dependencies, Collection fileExtensions) throws IOException { @@ -678,7 +676,6 @@ String dependencyChanges(Iterable> dependencies, Collection f * * @return {@code null} if the project does not need to be rebuilt, otherwise a message saying why to rebuild * @throws IOException if an error occurred while loading the cache file - * * @see Aspect#OPTIONS */ String optionChanges() throws IOException { @@ -713,7 +710,6 @@ private static StringBuilder causeOfRebuild(String cause, boolean colon) { * * @return {@code null} if the project does not need to be rebuilt, otherwise a message saying why to rebuild * @throws IOException if an error occurred while reading the time stamp of an output file - * * @see Aspect#CLASSES */ String markNewOrModifiedSources() throws IOException { @@ -762,7 +758,7 @@ List getModifiedSources() { * This method returns {@code true} if the given list is empty or contains only files * with the {@link SourceFile#ignoreModification} set to {@code true}. * - * @param sourceFiles return value of {@link #getModifiedSources()}. + * @param sourceFiles return value of {@link #getModifiedSources()} */ static boolean isEmptyOrIgnorable(List sourceFiles) { return !sourceFiles.stream().anyMatch((s) -> !s.ignoreModification); diff --git a/src/main/java/org/apache/maven/plugin/compiler/ModuleDirectoryRemover.java b/src/main/java/org/apache/maven/plugin/compiler/ModuleDirectoryRemover.java index 878b603df..2e96634fa 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ModuleDirectoryRemover.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ModuleDirectoryRemover.java @@ -54,8 +54,8 @@ final class ModuleDirectoryRemover implements Closeable { /** * Temporarily renames the given output directory for matching the layout of {@code javac} output. * - * @param outputDirectory the output directory (must exist) - * @param moduleName the name of the module + * @param outputDirectory the output directory (must exist) + * @param moduleName the name of the module * @throws IOException if an error occurred while renaming the output directory */ private ModuleDirectoryRemover(Path outputDirectory, String moduleName) throws IOException { @@ -68,8 +68,8 @@ private ModuleDirectoryRemover(Path outputDirectory, String moduleName) throws I /** * Temporarily renames the given output directory for matching the layout of {@code javac} output. * - * @param outputDirectory the output directory (must exist) - * @param moduleName the name of the module, or {@code null} if none + * @param outputDirectory the output directory (must exist) + * @param moduleName the name of the module, or {@code null} if none * @return a handler for restoring the directory to its original name, or {@code null} if there is no renaming * @throws IOException if an error occurred while renaming the output directory */ diff --git a/src/main/java/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.java b/src/main/java/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.java index a83a5e291..da2930170 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ModuleInfoOverwrite.java @@ -108,7 +108,7 @@ static ModuleInfoOverwrite create(Path source, Path mainOutputDirectory, Path te * to temporarily remove {@code module-info.class} from the test directory * (otherwise {@code javac} does not seem to consider that we are patching a module). * - * @throws IOException if an error occurred while renaming the file. + * @throws IOException if an error occurred while renaming the file */ private void substitute() throws IOException { Files.move(testSourceFile, savedSourceFile); @@ -123,7 +123,7 @@ private void substitute() throws IOException { /** * Restores the {@code module-info} file. * - * @throws IOException if an error occurred while renaming the file. + * @throws IOException if an error occurred while renaming the file */ void restore() throws IOException { if (shutdownHook != null) { 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 47b5b61ae..ddc33c50a 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/Options.java +++ b/src/main/java/org/apache/maven/plugin/compiler/Options.java @@ -363,8 +363,7 @@ public void addUnchecked(Iterable arguments) { * This is used for user-specified arguments. * * @param arguments the arguments to add, or {@code null} if none - * - * @deprecated Use {@link #addUnchecked(List)} instead. This method does not check for quoted strings. + * @deprecated use {@link #addUnchecked(List)} instead. This method does not check for quoted strings. */ @Deprecated(since = "4.0.0") void addUnchecked(String arguments) { 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 7f1995ded..8e2fe7183 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/PathFilter.java +++ b/src/main/java/org/apache/maven/plugin/compiler/PathFilter.java @@ -131,8 +131,8 @@ final class PathFilter extends SimpleFileVisitor { * Invoked for a file in a directory. If the given file passes the include/exclude filters, * then it is added to the list of source files. * - * @param file the source file to test - * @param attrs the file basic attributes + * @param file the source file to test + * @param attrs the file basic attributes * @return {@link FileVisitResult#CONTINUE} */ @Override 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 509bfdedf..23c30ea5f 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/PathSelector.java +++ b/src/main/java/org/apache/maven/plugin/compiler/PathSelector.java @@ -59,7 +59,6 @@ * * @author Benjamin Bentmann * @author Martin Desruisseaux - * * @see java.nio.file.FileSystem#getPathMatcher(String) */ final class PathSelector implements PathMatcher { 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 e89c01f7e..24a6da0f8 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/SourceDirectory.java +++ b/src/main/java/org/apache/maven/plugin/compiler/SourceDirectory.java @@ -163,9 +163,9 @@ final class SourceDirectory { * @param excludes patterns for excluding files below the root directory, or an empty list for no exclusion * @param fileKind kind of source files in this directory (usually {@code SOURCE}) * @param moduleName name of the module for which source directories are provided, or {@code null} if none - * @param release Java release for which source directories are provided, or {@code null} for the default release + * @param release java release for which source directories are provided, or {@code null} for the default release * @param outputDirectory the directory where to store the compilation results - * @param outputFileKind Kind of output files in the output directory (usually {@ codeCLASS}) + * @param outputFileKind kind of output files in the output directory (usually {@ codeCLASS}) */ @SuppressWarnings("checkstyle:ParameterNumber") private SourceDirectory( 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 017cb9597..0ed0cc94b 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/SourcesForRelease.java +++ b/src/main/java/org/apache/maven/plugin/compiler/SourcesForRelease.java @@ -103,7 +103,7 @@ String getReleaseString() { * Adds the given source file to this collection of source files. * The value of {@code source.directory.release}, if not null, must be equal to {@link #release}. * - * @param source the source file to add. + * @param source the source file to add */ void add(SourceFile source) { var directory = source.directory; 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 fa5ac6cf6..ff543d5e8 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/TestCompilerMojo.java +++ b/src/main/java/org/apache/maven/plugin/compiler/TestCompilerMojo.java @@ -115,7 +115,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { protected String testTarget; /** - * the {@code --release} argument for the test Java compiler + * The {@code --release} argument for the test Java compiler. * * @see CompilerMojo#release * @since 3.6 @@ -137,9 +137,8 @@ public class TestCompilerMojo extends AbstractCompilerMojo { /** * The arguments to be passed to test compiler. * - * @deprecated Replaced by {@link #testCompilerArgs} for consistency with the main phase. - * * @since 2.1 + * @deprecated replaced by {@link #testCompilerArgs} for consistency with the main phase */ @Parameter @Deprecated(since = "4.0.0") @@ -150,10 +149,9 @@ public class TestCompilerMojo extends AbstractCompilerMojo { * If this parameter is specified, it replaces {@link #compilerArgument}. * Otherwise, the {@code compilerArgument} parameter is used. * - * @deprecated Use {@link #testCompilerArgs} instead. - * * @see CompilerMojo#compilerArgument * @since 2.1 + * @deprecated use {@link #testCompilerArgs} instead */ @Parameter @Deprecated(since = "4.0.0") @@ -186,8 +184,7 @@ public class TestCompilerMojo extends AbstractCompilerMojo { * Dependencies are also placed on the class-path, unless their type is {@code module-jar}. * * @since 3.11 - * - * @deprecated Use {@code "claspath-jar"} dependency type instead, and avoid {@code module-info.java} in tests. + * @deprecated use {@code "claspath-jar"} dependency type instead, and avoid {@code module-info.java} in tests */ @Deprecated(since = "4.0.0") @Parameter(defaultValue = "true") @@ -240,7 +237,7 @@ public TestCompilerMojo() { * If {@link #skip} is {@code true}, then this method logs a message and does nothing else. * Otherwise, this method executes the steps described in the method of the parent class. * - * @throws MojoException if the compiler cannot be run. + * @throws MojoException if the compiler cannot be run */ @Override public void execute() throws MojoException { @@ -254,7 +251,7 @@ public void execute() throws MojoException { /** * Parses the parameters declared in the MOJO. * - * @param compiler the tools to use for verifying the validity of options + * @param compiler the tools to use for verifying the validity of options * @return the options after validation */ @Override @@ -414,9 +411,9 @@ final boolean hasModuleDeclaration(final List roots) throws IOE * Creates a new task for compiling the test classes. * * @param listener where to send compilation warnings, or {@code null} for the Maven logger - * @throws MojoException if this method identifies an invalid parameter in this MOJO * @return the task to execute for compiling the tests using the configuration in this MOJO * @throws IOException if an error occurred while creating the output directory or scanning the source directories + * @throws MojoException if this method identifies an invalid parameter in this MOJO */ @Override public ToolExecutor createExecutor(DiagnosticListener listener) throws IOException { 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 4177459b4..7d10dd2c5 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ToolExecutor.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ToolExecutor.java @@ -194,10 +194,9 @@ public class ToolExecutor { * * @param mojo the MOJO from which to take a snapshot * @param listener where to send compilation warnings, or {@code null} for the Maven logger - * @throws MojoException if this constructor identifies an invalid parameter in the MOJO * @throws IOException if an error occurred while creating the output directory or scanning the source directories * @throws MavenException if an error occurred while fetching dependencies - * + * @throws MojoException if this constructor identifies an invalid parameter in the MOJO * @see AbstractCompilerMojo#createExecutor(DiagnosticListener) */ @SuppressWarnings("deprecation") @@ -301,8 +300,8 @@ final boolean isReleaseSpecifiedForAll() { * * @param mojo the MOJO from which to take the incremental build configuration * @param configuration the options which should match the options used during the last build - * @throws IOException if an error occurred while accessing the cache file or walking through the directory tree * @return whether there is at least one file to recompile + * @throws IOException if an error occurred while accessing the cache file or walking through the directory tree */ public boolean applyIncrementalBuild(final AbstractCompilerMojo mojo, final Options configuration) throws IOException { @@ -363,7 +362,7 @@ public boolean applyIncrementalBuild(final AbstractCompilerMojo mojo, final Opti * The returned list is intentionally live: elements can be added or removed * from the list for changing the state of this executor. * - * @param pathType type of path for which to get the dependencies + * @param pathType type of path for which to get the dependencies */ protected List dependencies(PathType pathType) { return dependencies.computeIfAbsent(pathType, (key) -> new ArrayList<>()); @@ -450,7 +449,7 @@ private static SourceVersion nonNullOrLatest(SourceVersion release) { * * @param moduleName the module name, or an empty string if not explicitly specified * @return the specified module name, or an inferred module name if available, or an empty string - * @throws IOException if the module descriptor cannot be read. + * @throws IOException if the module descriptor cannot be read */ String inferModuleNameIfMissing(String moduleName) throws IOException { return moduleName; 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 6be8b699e..9a0057cdf 100644 --- a/src/main/java/org/apache/maven/plugin/compiler/ToolExecutorForTest.java +++ b/src/main/java/org/apache/maven/plugin/compiler/ToolExecutorForTest.java @@ -115,7 +115,7 @@ class ToolExecutorForTest extends ToolExecutor { * We keep that directory when the project is configured with the new {@code } element, * but have to remove it for compatibility reason if the project is compiled in the old way. * - * @deprecated Exists only for compatibility with the Maven 3 way to do a modular project. + * @deprecated exists only for compatibility with the Maven 3 way to do a modular project. * Is likely to cause confusion, for example with incremental builds. * New projects should use the {@code } elements instead. */ @@ -128,8 +128,8 @@ class ToolExecutorForTest extends ToolExecutor { * * @param mojo the MOJO from which to take a snapshot * @param listener where to send compilation warnings, or {@code null} for the Maven logger - * @throws MojoException if this constructor identifies an invalid parameter in the MOJO * @throws IOException if an error occurred while creating the output directory or scanning the source directories + * @throws MojoException if this constructor identifies an invalid parameter in the MOJO */ @SuppressWarnings("deprecation") ToolExecutorForTest(TestCompilerMojo mojo, DiagnosticListener listener) throws IOException { @@ -208,7 +208,7 @@ class ToolExecutorForTest extends ToolExecutor { * This method reads the module descriptor when first needed and caches the result. * This used if the user did not specified an explicit {@code } element in the sources. * - * @throws IOException if the module descriptor cannot be read. + * @throws IOException if the module descriptor cannot be read */ private String getMainModuleName() throws IOException { if (moduleName == null) {