Skip to content

Commit 5f32568

Browse files
authored
Javadoc fixes (#1030)
* Javadoc fixes * Iterable * typos
1 parent ac90050 commit 5f32568

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ enum Aspect {
7777
* not on the existence or modification times of the {@code *.class} files.
7878
*
7979
* <p>It is usually not needed to specify both {@code SOURCES} and {@link #CLASSES}.
80-
* But doing so it not forbidden.</p>
80+
* But doing so is not forbidden.</p>
8181
*
8282
* <h4>Implementation note</h4>
8383
* The checks use information about the previous build saved in {@code target/…/*.cache} files.
@@ -92,7 +92,7 @@ enum Aspect {
9292
* references to classes that no longer exist.
9393
*
9494
* <p>It is usually not needed to specify both {@link #SOURCES} and {@code CLASSES}.
95-
* But doing so it not forbidden.</p>
95+
* But doing so is not forbidden.</p>
9696
*
9797
* <h4>Implementation note</h4>
9898
* This check does not use or generate any {@code *.cache} file.
@@ -223,9 +223,9 @@ static EnumSet<Aspect> parse(final String values) {
223223
private static final byte NEW_SOURCE_DIRECTORY = 1, NEW_TARGET_DIRECTORY = 2;
224224

225225
/**
226-
* Flag in the binary output file telling that the output file of a source is different
227-
* than the one inferred by heuristic rules. For performance reason, we store the output
228-
* files explicitly only when it cannot be inferred.
226+
* Flag in the binary output file indicating that the output file of a source is different
227+
* from the one inferred by heuristic rules. For performance reasons, we store the output
228+
* file explicitly only when it cannot be inferred.
229229
*
230230
* @see javax.tools.JavaFileManager#getFileForOutput
231231
*/
@@ -326,7 +326,7 @@ static EnumSet<Aspect> parse(final String values) {
326326
* @param mojo the MOJO which is compiling source code
327327
* @param sourceFiles all source files
328328
* @param saveSourceList whether to save the list of source files in the cache
329-
* @param options the compiler options
329+
* @param configuration the compiler options
330330
* @param aspects result of {@link Aspect#parse(String)}
331331
* @throws IOException if the parent directory cannot be created
332332
*/
@@ -384,11 +384,10 @@ public void deleteCache() throws IOException {
384384
* </ul></li>
385385
* </ul>
386386
*
387-
* The "new source directory" flag is for avoiding to repeat the parent directory.
387+
* The "new source directory" flag is to avoid repeating the parent directory.
388388
* If that flag is {@code false}, then only the filename is stored and the parent
389389
* is the same as the previous file.
390390
*
391-
* @param sources whether to save also the list of source files
392391
* @throws IOException if an error occurred while writing the cache file
393392
*/
394393
@SuppressWarnings({"checkstyle:InnerAssignment", "checkstyle:NeedBraces"})

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
import org.apache.maven.api.plugin.Log;
3333

3434
/**
35-
* An helper class for preparing the options to pass to the tool (compiler or document generator).
35+
* A helper class for preparing the options to pass to the tool (compiler or document generator).
3636
* It does <em>not</em> include the options related to paths (class-path, destination directory, <i>etc.</i>).
3737
* If an option is unsupported by the tool, a message is logged at the warning level.
3838
*
@@ -364,7 +364,7 @@ public void addUnchecked(Iterable<String> arguments) {
364364
*
365365
* @param arguments the arguments to add, or {@code null} if none
366366
*
367-
* @deprecated Use {@link #addUnchecked(List)} instead. This method does not check for quoted strings.
367+
* @deprecated Use {@link #addUnchecked(Iterable)} instead. This method does not check for quoted strings.
368368
*/
369369
@Deprecated(since = "4.0.0")
370370
void addUnchecked(String arguments) {
@@ -418,7 +418,7 @@ void format(final StringBuilder commandLine, final Appendable out) throws IOExce
418418
}
419419

420420
/**
421-
* {@return a string representatation of the options for debugging purposes}
421+
* {@return a string representation of the options for debugging purposes}
422422
*/
423423
@Override
424424
public String toString() {

0 commit comments

Comments
 (0)