Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MCOMPILER-479] Clarify compiler arguments Javadoc #90

Merged
merged 1 commit into from Feb 5, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -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>
*
Expand All @@ -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;
Expand All @@ -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;
Expand Down