Skip to content

Commit

Permalink
Fix a few typos in CommandLine's JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
vorburger authored and remkop committed Dec 16, 2023
1 parent e0dbb42 commit 2dbc4a7
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/main/java/picocli/CommandLine.java
Original file line number Diff line number Diff line change
Expand Up @@ -3664,7 +3664,7 @@ private static class NoCompletionCandidates implements Iterable<String> {
public enum ScopeType {
/** The element only exists in the current command. */
LOCAL,
/** The element exists in the command where the element is defined and all descendents (subcommands, sub-subcommands, etc.). */
/** The element exists in the command where the element is defined and all descendants (subcommands, sub-subcommands, etc.). */
INHERIT,
}
/**
Expand Down Expand Up @@ -4944,7 +4944,7 @@ enum Target {
String multiplicity() default "0..1";
/** Determines whether picocli should validate the rules of this group ({@code true} by default).
* For a mutually exclusive group validation means verifying that no more than one elements of the group is specified on the command line;
* for a co-ocurring group validation means verifying that all elements of the group are specified on the command line.
* for a co-occurring group validation means verifying that all elements of the group are specified on the command line.
* Set {@link #validate() validate = false} for groups whose purpose is only to customize the usage help message.
* @see #multiplicity()
* @see #heading() */
Expand Down Expand Up @@ -7330,7 +7330,7 @@ public CommandSpec aliases(String... aliases) {
* @see Command#scope()
* @since 4.6 */
public boolean inherited() { return inherited; }
/** Returns the scope of this argument; it it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).
/** Returns the scope of this argument; is it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).
* @return whether this argument applies to all descendent subcommands of the command where it is defined
* @since 4.6 */
public ScopeType scopeType() { return scopeType == null ? ScopeType.LOCAL : scopeType; }
Expand Down Expand Up @@ -9031,7 +9031,7 @@ private String[] expandVariables(String[] desc) {
* Returns a regular expression to split option parameter for usage information.
* @see Option#splitSynopsisLabel()
* @since 4.3
* */
*/
public String splitRegexSynopsisLabel() { return interpolate(splitRegexSynopsisLabel); }

/** Returns whether this option should be excluded from the usage message.
Expand Down Expand Up @@ -9091,7 +9091,7 @@ public String mapFallbackValue() {
* the option will be reset to before parsing (regardless of whether a default value exists),
* to clear values that would otherwise remain from parsing previous input. */
public Object initialValue() {
// not not initialize if already CACHED, or UNAVAILABLE, or if annotatedElement==null
// Do not initialize if already CACHED, or UNAVAILABLE, or if annotatedElement==null
if (initialValueState == InitialValueState.POSTPONED && annotatedElement != null) {
try {
initialValue = annotatedElement.getter().get();
Expand Down Expand Up @@ -9179,7 +9179,7 @@ private String defaultValueFromProvider() {
/** Returns the binding {@link IScope} that determines on which object to set the value (or from which object to get the value) of this argument. */
public IScope scope() { return scope; }

/** Returns the scope of this argument; it it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).
/** Returns the scope of this argument; is it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).
* @return whether this argument applies to all descendent subcommands of the command where it is defined
* @since 4.3 */
public ScopeType scopeType() { return scopeType; }
Expand Down Expand Up @@ -10456,7 +10456,7 @@ public static class ArgGroupSpec implements IOrdered {

/** Returns whether picocli should validate the rules of this group:
* for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line;
* for a co-ocurring group this means that all arguments in the group are specified on the command line.
* for a co-occurring group this means that all arguments in the group are specified on the command line.
* {@code true} by default.
* @see ArgGroup#validate() */
public boolean validate() { return validate; }
Expand Down Expand Up @@ -10931,13 +10931,13 @@ public Builder updateArgGroupAttributes(ArgGroup group) {

/** Returns whether picocli should validate the rules of this group:
* for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line;
* for a co-ocurring group this means that all arguments in the group are specified on the command line.
* for a co-occurring group this means that all arguments in the group are specified on the command line.
* {@code true} by default.
* @see ArgGroup#validate() */
public boolean validate() { return validate; }
/** Sets whether picocli should validate the rules of this group:
* for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line;
* for a co-ocurring group this means that all arguments in the group are specified on the command line.
* for a co-occurring group this means that all arguments in the group are specified on the command line.
* {@code true} by default.
* @see ArgGroup#validate() */
public Builder validate(boolean newValue) { validate = newValue; return this; }
Expand Down

0 comments on commit 2dbc4a7

Please sign in to comment.