Skip to content

Commit c99a79a

Browse files
committed
Javadoc: Sentences start with a capitalize letter.
1 parent cfd100d commit c99a79a

6 files changed

Lines changed: 19 additions & 19 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ public CommandLine build() {
7777
/** The serial version UID. */
7878
private static final long serialVersionUID = 1L;
7979

80-
/** the unrecognized options/arguments */
80+
/** The unrecognized options/arguments */
8181
private final List<String> args = new LinkedList<>();
8282

83-
/** the processed options */
83+
/** The processed options */
8484
private final List<Option> options = new ArrayList<>();
8585

8686
/**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public int compare(final Option opt1, final Option opt2) {
9696
/** number of space characters to be prefixed to each description line */
9797
public static final int DEFAULT_DESC_PAD = 3;
9898

99-
/** the string to display at the beginning of the usage statement */
99+
/** The string to display at the beginning of the usage statement */
100100
public static final String DEFAULT_SYNTAX_PREFIX = "usage: ";
101101

102102
/** default prefix for shortOpts */

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ public class Option implements Cloneable, Serializable {
4949
*/
5050
public static final class Builder {
5151

52-
/** the name of the option */
52+
/** The name of the option */
5353
private final String option;
5454

5555
/** description of the option */
5656
private String description;
5757

58-
/** the long representation of the option */
58+
/** The long representation of the option */
5959
private String longOption;
6060

61-
/** the name of the argument for this option */
61+
/** The name of the argument for this option */
6262
private String argName;
6363

6464
/** specifies whether this option is required to be present */
@@ -67,13 +67,13 @@ public static final class Builder {
6767
/** specifies whether the argument value of this Option is optional */
6868
private boolean optionalArg;
6969

70-
/** the number of argument values this option can have */
70+
/** The number of argument values this option can have */
7171
private int argCount = UNINITIALIZED;
7272

73-
/** the type of this Option */
73+
/** The type of this Option */
7474
private Class<?> type = String.class;
7575

76-
/** the character that is the value separator */
76+
/** The character that is the value separator */
7777
private char valueSeparator;
7878

7979
/**
@@ -282,13 +282,13 @@ public static Builder builder(final String opt) {
282282
return new Builder(opt);
283283
}
284284

285-
/** the name of the option */
285+
/** The name of the option */
286286
private final String opt;
287287

288-
/** the long representation of the option */
288+
/** The long representation of the option */
289289
private String longOpt;
290290

291-
/** the name of the argument for this option */
291+
/** The name of the argument for this option */
292292
private String argName;
293293

294294
/** description of the option */
@@ -300,16 +300,16 @@ public static Builder builder(final String opt) {
300300
/** specifies whether the argument value of this Option is optional */
301301
private boolean optionalArg;
302302

303-
/** the number of argument values this option can have */
303+
/** The number of argument values this option can have */
304304
private int numberOfArgs = UNINITIALIZED;
305305

306-
/** the type of this Option */
306+
/** The type of this Option */
307307
private Class<?> type = String.class;
308308

309-
/** the list of argument values **/
309+
/** The list of argument values **/
310310
private List<String> values = new ArrayList<>();
311311

312-
/** the character that is the value separator */
312+
/** The character that is the value separator */
313313
private char valuesep;
314314

315315
/**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public final class OptionBuilder {
4242
/** is required? */
4343
private static boolean required;
4444

45-
/** the number of arguments */
45+
/** The number of arguments */
4646
private static int numberOfArgs = Option.UNINITIALIZED;
4747

4848
/** option type */

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public class OptionGroup implements Serializable {
3333
/** hold the options */
3434
private final Map<String, Option> optionMap = new LinkedHashMap<>();
3535

36-
/** the name of the selected option */
36+
/** The name of the selected option */
3737
private String selected;
3838

3939
/** specified whether this group is required */

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public class PosixParser extends Parser {
3939
/** holder for the current option */
4040
private Option currentOption;
4141

42-
/** the command line Options */
42+
/** The command line Options */
4343
private Options options;
4444

4545
/**

0 commit comments

Comments
 (0)