You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2022/02/06 00:06:10 UTC
[maven-compiler-plugin] branch master updated: [MCOMPILER-479] Clarify compiler arguments Javadoc (#90)
This is an automated email from the ASF dual-hosted git repository.
olamy 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 1176891 [MCOMPILER-479] Clarify compiler arguments Javadoc (#90)
1176891 is described below
commit 11768914f5fe9e383a46d3fddad6252cc3c35968
Author: Halil İbrahim Şener <hi...@gmail.com>
AuthorDate: Sun Feb 6 00:49:44 2022 +0100
[MCOMPILER-479] Clarify compiler arguments Javadoc (#90)
---
.../maven/plugin/compiler/AbstractCompilerMojo.java | 19 ++++++++++++++-----
1 file changed, 14 insertions(+), 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
index 99c263f..20d92a0 100644
--- 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>
* <compilerArgs>
@@ -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;