Skip to content

Commit d2506e3

Browse files
committed
Javadoc
1 parent 81f7c1e commit d2506e3

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

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

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@ Licensed to the Apache Software Foundation (ASF) under one or more
3030
* Main entry-point into the library.
3131
* <p>
3232
* Options represents a collection of {@link Option} objects, which describe the possible options for a command-line.
33+
* </p>
3334
* <p>
3435
* It may flexibly parse long and short options, with or without values. Additionally, it may parse only a portion of a
3536
* commandline, allowing for flexible multi-stage parsing.
37+
* </p>
3638
*
3739
* @see org.apache.commons.cli.CommandLine
3840
*/
@@ -78,8 +80,7 @@ public Options addOption(final Option opt) {
7880
}
7981

8082
/**
81-
* Add an option that only contains a short-name.
82-
*
83+
* Adds an option that only contains a short-name.
8384
* <p>
8485
* It may be specified as requiring an argument.
8586
* </p>
@@ -95,8 +96,7 @@ public Options addOption(final String opt, final boolean hasArg, final String de
9596
}
9697

9798
/**
98-
* Add an option that only contains a short name.
99-
*
99+
* Adds an option that only contains a short name.
100100
* <p>
101101
* The option does not take an argument.
102102
* </p>
@@ -112,8 +112,7 @@ public Options addOption(final String opt, final String description) {
112112
}
113113

114114
/**
115-
* Add an option that contains a short-name and a long-name.
116-
*
115+
* Adds an option that contains a short-name and a long-name.
117116
* <p>
118117
* It may be specified as requiring an argument.
119118
* </p>
@@ -130,7 +129,7 @@ public Options addOption(final String opt, final String longOpt, final boolean h
130129
}
131130

132131
/**
133-
* Add the specified option group.
132+
* Adds the specified option group.
134133
*
135134
* @param group the OptionGroup that is to be added
136135
* @return the resulting Options instance
@@ -170,12 +169,10 @@ public Options addOptions(final Options options) {
170169
}
171170

172171
/**
173-
* Add an option that contains a short-name and a long-name.
174-
*
172+
* Adds an option that contains a short-name and a long-name.
175173
* <p>
176174
* The added option is set as required. It may be specified as requiring an argument. This method is a shortcut for:
177175
* </p>
178-
*
179176
* <pre>
180177
* <code>
181178
* Options option = new Option(opt, longOpt, hasArg, description);
@@ -222,7 +219,6 @@ public List<String> getMatchingOptions(final String opt) {
222219

223220
/**
224221
* Gets the {@link Option} matching the long or short name specified.
225-
*
226222
* <p>
227223
* The leading hyphens in the name are ignored (up to 2).
228224
* </p>

0 commit comments

Comments
 (0)