This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-compiler-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 5f32568 Javadoc fixes (#1030)
5f32568 is described below
commit 5f32568ba7007fe9cc9935a348bc1bb05c818cc3
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Sat Feb 7 21:23:41 2026 +0000
Javadoc fixes (#1030)
* Javadoc fixes
* Iterable
* typos
---
.../apache/maven/plugin/compiler/IncrementalBuild.java | 15 +++++++--------
.../java/org/apache/maven/plugin/compiler/Options.java | 6 +++---
2 files changed, 10 insertions(+), 11 deletions(-)
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 f50b575..dacf393 100644
--- a/src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java
+++ b/src/main/java/org/apache/maven/plugin/compiler/IncrementalBuild.java
@@ -77,7 +77,7 @@ final class IncrementalBuild {
* not on the existence or modification times of the {@code *.class}
files.
*
* <p>It is usually not needed to specify both {@code SOURCES} and
{@link #CLASSES}.
- * But doing so it not forbidden.</p>
+ * But doing so is not forbidden.</p>
*
* <h4>Implementation note</h4>
* The checks use information about the previous build saved in {@code
target/…/*.cache} files.
@@ -92,7 +92,7 @@ final class IncrementalBuild {
* references to classes that no longer exist.
*
* <p>It is usually not needed to specify both {@link #SOURCES} and
{@code CLASSES}.
- * But doing so it not forbidden.</p>
+ * But doing so is not forbidden.</p>
*
* <h4>Implementation note</h4>
* This check does not use or generate any {@code *.cache} file.
@@ -223,9 +223,9 @@ final class IncrementalBuild {
private static final byte NEW_SOURCE_DIRECTORY = 1, NEW_TARGET_DIRECTORY =
2;
/**
- * Flag in the binary output file telling that the output file of a source
is different
- * than the one inferred by heuristic rules. For performance reason, we
store the output
- * files explicitly only when it cannot be inferred.
+ * Flag in the binary output file indicating that the output file of a
source is different
+ * from the one inferred by heuristic rules. For performance reasons, we
store the output
+ * file explicitly only when it cannot be inferred.
*
* @see javax.tools.JavaFileManager#getFileForOutput
*/
@@ -326,7 +326,7 @@ final class IncrementalBuild {
* @param mojo the MOJO which is compiling source code
* @param sourceFiles all source files
* @param saveSourceList whether to save the list of source files in the
cache
- * @param options the compiler options
+ * @param configuration the compiler options
* @param aspects result of {@link Aspect#parse(String)}
* @throws IOException if the parent directory cannot be created
*/
@@ -384,11 +384,10 @@ final class IncrementalBuild {
* </ul></li>
* </ul>
*
- * The "new source directory" flag is for avoiding to repeat the parent
directory.
+ * The "new source directory" flag is to avoid repeating the parent
directory.
* If that flag is {@code false}, then only the filename is stored and the
parent
* is the same as the previous file.
*
- * @param sources whether to save also the list of source files
* @throws IOException if an error occurred while writing the cache file
*/
@SuppressWarnings({"checkstyle:InnerAssignment", "checkstyle:NeedBraces"})
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 74e664e..ced87dd 100644
--- a/src/main/java/org/apache/maven/plugin/compiler/Options.java
+++ b/src/main/java/org/apache/maven/plugin/compiler/Options.java
@@ -32,7 +32,7 @@ import java.util.function.UnaryOperator;
import org.apache.maven.api.plugin.Log;
/**
- * An helper class for preparing the options to pass to the tool (compiler or
document generator).
+ * A helper class for preparing the options to pass to the tool (compiler or
document generator).
* It does <em>not</em> include the options related to paths (class-path,
destination directory, <i>etc.</i>).
* If an option is unsupported by the tool, a message is logged at the warning
level.
*
@@ -364,7 +364,7 @@ public final class Options {
*
* @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(Iterable)} instead. This method
does not check for quoted strings.
*/
@Deprecated(since = "4.0.0")
void addUnchecked(String arguments) {
@@ -418,7 +418,7 @@ public final class Options {
}
/**
- * {@return a string representatation of the options for debugging
purposes}
+ * {@return a string representation of the options for debugging purposes}
*/
@Override
public String toString() {
