Javadoc

Author: garydgregory

src/main/java/org/apache/commons/cli/HelpFormatter.java

@@ -93,7 +93,7 @@ public int compare(final Option opt1, final Option opt2) {
     /** 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 */

src/main/java/org/apache/commons/cli/Option.java

@@ -59,7 +59,7 @@ public static final class Builder {
         /** 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 static final class Builder {
         /** 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 */

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;
 
     /**

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<>();
 
     /**

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;
 
     /**

src/main/java/org/apache/commons/cli/PosixParser.java

@@ -30,13 +30,13 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  */
 @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 */