This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-cli.git
commit c99a79a0d0d7ffa7281c49c270ea6326f08cb0cc Author: Gary Gregory <[email protected]> AuthorDate: Mon Oct 4 14:55:15 2021 -0400 Javadoc: Sentences start with a capitalize letter. --- .../java/org/apache/commons/cli/CommandLine.java | 4 ++-- .../java/org/apache/commons/cli/HelpFormatter.java | 2 +- src/main/java/org/apache/commons/cli/Option.java | 26 +++++++++++----------- .../java/org/apache/commons/cli/OptionBuilder.java | 2 +- .../java/org/apache/commons/cli/OptionGroup.java | 2 +- .../java/org/apache/commons/cli/PosixParser.java | 2 +- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java b/src/main/java/org/apache/commons/cli/CommandLine.java index ab79533..a8e8d19 100644 --- a/src/main/java/org/apache/commons/cli/CommandLine.java +++ b/src/main/java/org/apache/commons/cli/CommandLine.java @@ -77,10 +77,10 @@ public class CommandLine implements Serializable { /** The serial version UID. */ private static final long serialVersionUID = 1L; - /** the unrecognized options/arguments */ + /** The unrecognized options/arguments */ private final List<String> args = new LinkedList<>(); - /** the processed options */ + /** The processed options */ private final List<Option> options = new ArrayList<>(); /** diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java b/src/main/java/org/apache/commons/cli/HelpFormatter.java index acecfb4..1db5953 100644 --- a/src/main/java/org/apache/commons/cli/HelpFormatter.java +++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java @@ -96,7 +96,7 @@ public class HelpFormatter { /** number of space characters to be prefixed to each description line */ public static final int DEFAULT_DESC_PAD = 3; - /** the string to display at the beginning of the usage statement */ + /** The string to display at the beginning of the usage statement */ public static final String DEFAULT_SYNTAX_PREFIX = "usage: "; /** default prefix for shortOpts */ diff --git a/src/main/java/org/apache/commons/cli/Option.java b/src/main/java/org/apache/commons/cli/Option.java index 93444c1..7b8f2d6 100644 --- a/src/main/java/org/apache/commons/cli/Option.java +++ b/src/main/java/org/apache/commons/cli/Option.java @@ -49,16 +49,16 @@ public class Option implements Cloneable, Serializable { */ public static final class Builder { - /** the name of the option */ + /** The name of the option */ private final String option; /** description of the option */ private String description; - /** the long representation of the option */ + /** The long representation of the option */ private String longOption; - /** the name of the argument for this option */ + /** The name of the argument for this option */ private String argName; /** specifies whether this option is required to be present */ @@ -67,13 +67,13 @@ public class Option implements Cloneable, Serializable { /** specifies whether the argument value of this Option is optional */ private boolean optionalArg; - /** the number of argument values this option can have */ + /** The number of argument values this option can have */ private int argCount = UNINITIALIZED; - /** the type of this Option */ + /** The type of this Option */ private Class<?> type = String.class; - /** the character that is the value separator */ + /** The character that is the value separator */ private char valueSeparator; /** @@ -282,13 +282,13 @@ public class Option implements Cloneable, Serializable { return new Builder(opt); } - /** the name of the option */ + /** The name of the option */ private final String opt; - /** the long representation of the option */ + /** The long representation of the option */ private String longOpt; - /** the name of the argument for this option */ + /** The name of the argument for this option */ private String argName; /** description of the option */ @@ -300,16 +300,16 @@ public class Option implements Cloneable, Serializable { /** specifies whether the argument value of this Option is optional */ private boolean optionalArg; - /** the number of argument values this option can have */ + /** The number of argument values this option can have */ private int numberOfArgs = UNINITIALIZED; - /** the type of this Option */ + /** The type of this Option */ private Class<?> type = String.class; - /** the list of argument values **/ + /** The list of argument values **/ private List<String> values = new ArrayList<>(); - /** the character that is the value separator */ + /** The character that is the value separator */ private char valuesep; /** diff --git a/src/main/java/org/apache/commons/cli/OptionBuilder.java b/src/main/java/org/apache/commons/cli/OptionBuilder.java index 7aa4803..7bc4011 100644 --- a/src/main/java/org/apache/commons/cli/OptionBuilder.java +++ b/src/main/java/org/apache/commons/cli/OptionBuilder.java @@ -42,7 +42,7 @@ public final class OptionBuilder { /** is required? */ private static boolean required; - /** the number of arguments */ + /** The number of arguments */ private static int numberOfArgs = Option.UNINITIALIZED; /** option type */ diff --git a/src/main/java/org/apache/commons/cli/OptionGroup.java b/src/main/java/org/apache/commons/cli/OptionGroup.java index ef07014..c4c7be4 100644 --- a/src/main/java/org/apache/commons/cli/OptionGroup.java +++ b/src/main/java/org/apache/commons/cli/OptionGroup.java @@ -33,7 +33,7 @@ public class OptionGroup implements Serializable { /** hold the options */ private final Map<String, Option> optionMap = new LinkedHashMap<>(); - /** the name of the selected option */ + /** The name of the selected option */ private String selected; /** specified whether this group is required */ diff --git a/src/main/java/org/apache/commons/cli/PosixParser.java b/src/main/java/org/apache/commons/cli/PosixParser.java index 0197c49..7d7838f 100644 --- a/src/main/java/org/apache/commons/cli/PosixParser.java +++ b/src/main/java/org/apache/commons/cli/PosixParser.java @@ -39,7 +39,7 @@ public class PosixParser extends Parser { /** holder for the current option */ private Option currentOption; - /** the command line Options */ + /** The command line Options */ private Options options; /**
