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.

Author: desruisseaux

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,31 +947,31 @@ protected AbstractCompilerMojo(PathScope compileScope) {
  }
 
  /**
- * {@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.
  */
  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.
  */
  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
  */
  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 @@ && getExcludes().isEmpty()
  }
 
  /**
- * {@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 @@ protected String getSource() {
  }
 
  /**
- * {@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 @@ protected String getTarget() {
  }
 
  /**
- * {@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 @@ protected String getRelease() {
  }
 
  /**
- * {@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 @@ final Stream<SourceRoot> getSourceRoots(ProjectScope scope) {
  }
 
  /**
- * {@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 @@ final List<SourceDirectory> getSourceDirectories(final Path outputDirectory) thr
  }
 
  /**
- * {@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 @@ String moduleOfPreviousExecution() throws IOException {
  }
 
  /**
- * {@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 @@ boolean hasModuleDeclaration(final List<SourceDirectory> roots) throws IOExcepti
  }
 
  /**
- * {@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 @@ boolean hasModuleDeclaration(final List<SourceDirectory> roots) throws IOExcepti
  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 ToolExecutor createExecutor(DiagnosticListener<? super JavaFileObject> li
  }
 
  /**
- * {@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 @@ private boolean isVersionEqualOrNewer(String sourceVersion) {
  }
 
  /**
- * {@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 @@ 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.
+ * {@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 @@ final void resolveProcessorPathEntries(Map<PathType, List<Path>> addTo) throws M
  }
 
  /**
- * {@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

src/main/java/org/apache/maven/plugin/compiler/CompilerMojo.java

@@ -226,7 +226,7 @@ public Options parseParameters(final OptionChecker compiler) {
  }
 
  /**
- * {@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,31 +235,31 @@ protected Path getGeneratedSourcesDirectory() {
  }
 
  /**
- * {@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() {
  return (includes != null) ? includes : Set.of();
  }
 
  /**
- * {@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() {
  return (excludes != null) ? excludes : Set.of();
  }
 
  /**
- * {@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() {
  return (incrementalExcludes != null) ? incrementalExcludes : Set.of();
  }
 
  /**
- * {@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 @@ protected Path getOutputDirectory() {
  }
 
  /**
- * {@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 ToolExecutor createExecutor(DiagnosticListener<? super JavaFileObject> li
  }
 
  /**
- * {@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 @@ final boolean hasModuleDeclaration(final List<SourceDirectory> roots) throws IOE
  }
 
  /**
- * {@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 @@ 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}.
+ * {@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.

src/main/java/org/apache/maven/plugin/compiler/DiagnosticLogger.java

@@ -217,7 +217,7 @@ void logSummary() {
  }
 
  /**
- * {@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.
  */

src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java

@@ -772,7 +772,7 @@ List<SourceFile> getModifiedSources() {
  }
 
  /**
- * {@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}.
  *

src/main/java/org/apache/maven/plugin/compiler/ModuleInfoPatch.java

@@ -372,7 +372,7 @@ private static void readQualified(StreamTokenizer reader, Map<String, Set<String
  }
 
  /**
- * {@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 @@ public ModuleInfoPatch patchWithSameReads(String otherModule) {
  }
 
  /**
- * {@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;

src/main/java/org/apache/maven/plugin/compiler/Options.java

@@ -418,7 +418,7 @@ void format(final StringBuilder commandLine, final Appendable out) throws IOExce
  }
 
  /**
- * {@return a string representatation of the options for debugging purposes}.
+ * {@return a string representatation of the options for debugging purposes}
  */
  @Override
  public String toString() {

src/main/java/org/apache/maven/plugin/compiler/PathFilter.java

@@ -157,7 +157,7 @@ public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) th
  }
 
  /**
- * {@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.
  *

src/main/java/org/apache/maven/plugin/compiler/PathSelector.java

@@ -473,7 +473,7 @@ private static PathMatcher[] matchers(final FileSystem fs, final String[] patter
  }
 
  /**
- * {@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 @@ public boolean matches(Path path) {
  }
 
  /**
- * {@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 @@ private static void append(StringBuilder buffer, String label, String[] patterns
  }
 
  /**
- * {@return a string representation for logging purposes}.
+ * {@return a string representation for logging purposes}
  */
  @Override
  public String toString() {

src/main/java/org/apache/maven/plugin/compiler/SourceDirectory.java

@@ -233,7 +233,7 @@ static Path outputDirectoryForReleases(Path outputDirectory) {
  }
 
  /**
- * {@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 @@ public Optional<Path> getModuleInfo() {
  }
 
  /**
- * {@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 @@ public Optional<SourceVersion> getSpecificVersion() {
  }
 
  /**
- * {@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,15 +409,15 @@ public boolean equals(Object obj) {
  }
 
  /**
- * {@return a hash code value for this root directory}.
+ * {@return a hash code value for this root directory}
  */
  @Override
  public int hashCode() {
  return Objects.hash(root, moduleName, release);
  }
 
  /**
- * {@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() {