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
The following commit(s) were added to refs/heads/master by this push:
new a50d085 Javadoc
a50d085 is described below
commit a50d085991399dd2a991af83e963148986d5542f
Author: Gary Gregory <[email protected]>
AuthorDate: Thu Dec 14 13:47:04 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/cli/HelpFormatter.java | 2 +-
src/main/java/org/apache/commons/cli/Option.java | 6 +++---
src/main/java/org/apache/commons/cli/OptionGroup.java | 4 ++--
src/main/java/org/apache/commons/cli/Options.java | 8 ++++----
src/main/java/org/apache/commons/cli/Parser.java | 4 ++--
src/main/java/org/apache/commons/cli/PosixParser.java | 6 +++---
6 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index 2f480e8..0bf245e 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -93,7 +93,7 @@ public class HelpFormatter {
/** Default padding to the left of each line */
public static final int DEFAULT_LEFT_PAD = 1;
- /** number of space characters to be prefixed to each description line */
+ /** 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 */
diff --git a/src/main/java/org/apache/commons/cli/Option.java
b/src/main/java/org/apache/commons/cli/Option.java
index fef6f03..7834fc8 100644
--- a/src/main/java/org/apache/commons/cli/Option.java
+++ b/src/main/java/org/apache/commons/cli/Option.java
@@ -59,7 +59,7 @@ public class Option implements Cloneable, Serializable {
/** The name of the option */
private String option;
- /** description of the option */
+ /** Description of the option */
private String description;
/** The long representation of the option */
@@ -68,10 +68,10 @@ public class Option implements Cloneable, Serializable {
/** The name of the argument for this option */
private String argName;
- /** specifies whether this option is required to be present */
+ /** Specifies whether this option is required to be present */
private boolean required;
- /** specifies whether the argument value of this Option is optional */
+ /** Specifies whether the argument value of this Option is optional */
private boolean optionalArg;
/** The number of argument values this option can have */
diff --git a/src/main/java/org/apache/commons/cli/OptionGroup.java
b/src/main/java/org/apache/commons/cli/OptionGroup.java
index 3e21f2f..5a16ae7 100644
--- a/src/main/java/org/apache/commons/cli/OptionGroup.java
+++ b/src/main/java/org/apache/commons/cli/OptionGroup.java
@@ -30,13 +30,13 @@ public class OptionGroup implements Serializable {
/** The serial version UID. */
private static final long serialVersionUID = 1L;
- /** hold the options */
+ /** Hold the options */
private final Map<String, Option> optionMap = new LinkedHashMap<>();
/** The name of the selected option */
private String selected;
- /** specified whether this group is required */
+ /** Specified whether this group is required */
private boolean required;
/**
diff --git a/src/main/java/org/apache/commons/cli/Options.java
b/src/main/java/org/apache/commons/cli/Options.java
index f87ca90..63fa86b 100644
--- a/src/main/java/org/apache/commons/cli/Options.java
+++ b/src/main/java/org/apache/commons/cli/Options.java
@@ -40,18 +40,18 @@ public class Options implements Serializable {
/** The serial version UID. */
private static final long serialVersionUID = 1L;
- /** a map of the options with the character key */
+ /** A map of the options with the character key */
private final Map<String, Option> shortOpts = new LinkedHashMap<>();
- /** a map of the options with the long key */
+ /** A map of the options with the long key */
private final Map<String, Option> longOpts = new LinkedHashMap<>();
- /** a map of the required options */
+ /** A map of the required options */
// N.B. This can contain either a String (addOption) or an OptionGroup
(addOptionGroup)
// TODO this seems wrong
private final List<Object> requiredOpts = new ArrayList<>();
- /** a map of the option groups */
+ /** A map of the option groups */
private final Map<String, OptionGroup> optionGroups = new
LinkedHashMap<>();
/**
diff --git a/src/main/java/org/apache/commons/cli/Parser.java
b/src/main/java/org/apache/commons/cli/Parser.java
index 22d9f0a..a524e00 100644
--- a/src/main/java/org/apache/commons/cli/Parser.java
+++ b/src/main/java/org/apache/commons/cli/Parser.java
@@ -34,10 +34,10 @@ public abstract class Parser implements CommandLineParser {
/** CommandLine instance */
protected CommandLine cmd;
- /** current Options */
+ /** Current Options */
private Options options;
- /** list of required options strings */
+ /** List of required options strings */
private List requiredOptions;
/**
diff --git a/src/main/java/org/apache/commons/cli/PosixParser.java
b/src/main/java/org/apache/commons/cli/PosixParser.java
index b304668..702fe03 100644
--- a/src/main/java/org/apache/commons/cli/PosixParser.java
+++ b/src/main/java/org/apache/commons/cli/PosixParser.java
@@ -30,13 +30,13 @@ import java.util.List;
*/
@Deprecated
public class PosixParser extends Parser {
- /** holder for flattened tokens */
+ /** Holder for flattened tokens */
private final List<String> tokens = new ArrayList<>();
- /** specifies if bursting should continue */
+ /** Specifies if bursting should continue */
private boolean eatTheRest;
- /** holder for the current option */
+ /** Holder for the current option */
private Option currentOption;
/** The command line Options */
