mirror of
https://github.com/jlengrand/picocli.git
synced 2026-03-10 08:41:17 +00:00
DOC fix javadoc warnings and broken links
This commit is contained in:
@@ -157,6 +157,10 @@ jar {
|
||||
}
|
||||
|
||||
javadoc.options.overview = "src/main/java/overview.html"
|
||||
javadoc.options.links += [
|
||||
'https://docs.oracle.com/javase/8/docs/api/',
|
||||
'http://docs.groovy-lang.org/2.4.9/html/gapi'
|
||||
]
|
||||
javadoc.dependsOn('asciidoctor')
|
||||
asciidoctorj {
|
||||
version = '1.5.5'
|
||||
|
||||
@@ -938,12 +938,12 @@ public class CommandLine {
|
||||
}
|
||||
|
||||
/** Returns the color scheme to use when printing help.
|
||||
* The default value is the {@linkplain picocli.CommandLine.Help#defaultColorScheme(Help.Ansi) default color scheme} with {@link Help.Ansi#AUTO Ansi.AUTO}.
|
||||
* The default value is the {@linkplain picocli.CommandLine.Help#defaultColorScheme(CommandLine.Help.Ansi) default color scheme} with {@link Help.Ansi#AUTO Ansi.AUTO}.
|
||||
* @see #execute(String...)
|
||||
* @see #usage(PrintStream)
|
||||
* @see #usage(PrintWriter)
|
||||
* @see #getUsageMessage()
|
||||
* @see Help#defaultColorScheme(Help.Ansi)
|
||||
* @see Help#defaultColorScheme(CommandLine.Help.Ansi)
|
||||
* @since 4.0
|
||||
*/
|
||||
public Help.ColorScheme getColorScheme() { return colorScheme; }
|
||||
@@ -4843,10 +4843,10 @@ public class CommandLine {
|
||||
* @since 4.0 */
|
||||
public CommandSpec setAddMethodSubcommands(Boolean addMethodSubcommands) { isAddMethodSubcommands = addMethodSubcommands; return this; }
|
||||
|
||||
/** Returns whether whether variables should be interpolated in String values. {@value #DEFAULT_INTERPOLATE_VARIABLES} by default.
|
||||
/** Returns whether whether variables should be interpolated in String values. True by default.
|
||||
* @since 4.0 */
|
||||
public boolean interpolateVariables() { return (interpolateVariables == null) ? DEFAULT_INTERPOLATE_VARIABLES : interpolateVariables; }
|
||||
/** Sets whether whether variables should be interpolated in String values. {@value #DEFAULT_INTERPOLATE_VARIABLES} by default.
|
||||
/** Sets whether whether variables should be interpolated in String values. True by default.
|
||||
* @since 4.0 */
|
||||
public CommandSpec interpolateVariables(Boolean interpolate) { interpolateVariables = interpolate; return this; }
|
||||
|
||||
@@ -5949,7 +5949,7 @@ public class CommandLine {
|
||||
* usage.exitCodeList.1 = 64:Invalid input: an unknown option or invalid parameter was specified.
|
||||
* usage.exitCodeList.2 = 70:Execution exception: an exception occurred while executing the business logic.
|
||||
* </pre>
|
||||
* @newValue a map with values to be displayed in the exit codes section
|
||||
* @param newValue a map with values to be displayed in the exit codes section
|
||||
* @see #keyValuesMap(String...)
|
||||
* @since 4.0 */
|
||||
public UsageMessageSpec exitCodeList(Map<String, String> newValue) { exitCodeList = newValue == null ? null : Collections.unmodifiableMap(new LinkedHashMap<String, String>(newValue)); return this;}
|
||||
|
||||
@@ -18,6 +18,8 @@ package picocli.groovy;
|
||||
import groovy.lang.MissingPropertyException;
|
||||
import groovy.lang.Script;
|
||||
import picocli.CommandLine;
|
||||
import picocli.CommandLine.Parameters;
|
||||
import picocli.CommandLine.Option;
|
||||
import picocli.CommandLine.ExecutionException;
|
||||
import picocli.CommandLine.ParameterException;
|
||||
|
||||
@@ -83,8 +85,8 @@ abstract public class PicocliBaseScript extends Script {
|
||||
* {@code this.commandLine}). {@code CommandLine} creation and initialization may be
|
||||
* customized by overriding {@link #createCommandLine()}.</li>
|
||||
* <li>The {@link #parseScriptArguments(CommandLine, String[])} method is called with the script arguments.
|
||||
* This initialises all {@code @Field} variables annotated with {@link CommandLine.Option} or
|
||||
* {@link CommandLine.Parameters}, unless the user input was invalid.</li>
|
||||
* This initialises all {@code @Field} variables annotated with {@link Option} or
|
||||
* {@link Parameters}, unless the user input was invalid.</li>
|
||||
* <li>If the user input was invalid, an error message and the usage message are printed to standard err and the
|
||||
* script exits. This may be customized by overriding
|
||||
* {@link #handleParameterException(CommandLine.ParameterException, String[])}.</li>
|
||||
|
||||
Reference in New Issue
Block a user