[MCOMPILER-479] Clarify compiler arguments Javadoc (#90)

apache · Feb 5, 2022 · 1176891 · 1176891
1 parent defecd0
commit 1176891
Showing 1 changed file with 14 additions and 5 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
@@ -307,12 +307,15 @@ public abstract class AbstractCompilerMojo
 
     /**
      * <p>
-     * Sets the arguments to be passed to the compiler (prepending a dash) if {@link #fork} is set to <code>true</code>.
+     * Sets the arguments to be passed to the compiler (prepending a dash).
      * </p>
      * <p>
      * This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.
      * </p>
      * <p>
+     * Note that {@code -J} options are only passed through if {@link #fork} is set to {@code true}.
+     * </p>
+     * <p>
      * To pass <code>-Xmaxerrs 1000 -Xlint -Xlint:-path -Averbose=true</code> you should include the following:
      * </p>
      *
@@ -334,7 +337,11 @@ public abstract class AbstractCompilerMojo
 
     /**
      * <p>
-     * Sets the arguments to be passed to the compiler if {@link #fork} is set to <code>true</code>.
+     * Sets the arguments to be passed to the compiler.
+     * </p>
+     * <p>
+     * Note that {@code -J} options are only passed through if {@link #fork} is set to {@code true}.
+     * </p>
      * Example:
      * <pre>
      * &lt;compilerArgs&gt;
@@ -352,13 +359,15 @@ public abstract class AbstractCompilerMojo
 
     /**
      * <p>
-     * Sets the unformatted single argument string to be passed to the compiler if {@link #fork} is set to
-     * <code>true</code>. To pass multiple arguments such as <code>-Xmaxerrs 1000</code> (which are actually two
-     * arguments) you have to use {@link #compilerArguments}.
+     * Sets the unformatted single argument string to be passed to the compiler. To pass multiple arguments such as
+     * <code>-Xmaxerrs 1000</code> (which are actually two arguments) you have to use {@link #compilerArguments}.
      * </p>
      * <p>
      * This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.
      * </p>
+     * <p>
+     * Note that {@code -J} options are only passed through if {@link #fork} is set to {@code true}.
+     * </p>
      */
     @Parameter
     protected String compilerArgument;