Skip to content

Commit 336b358

Browse files
committed
Adds docs to SupportedOptions
Signed-off-by: Manoel Campos <manoelcampos@gmail.com>
1 parent 024688c commit 336b358

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/main/java/com/github/markusbernhardt/xmldoclet/SupportedOptions.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ Set<CustomOption> toDocletOptions() {
5252
return cliOptions.getOptions().stream().map(CustomOption::of).collect(toSet());
5353
}
5454

55+
/**
56+
* Creates a new Apache Commons CLI option with one argument that has the same name of the option itself.
57+
* @param optionName name of the option and its own single argument
58+
* @param description option description
59+
*/
5560
private void newOneArgOption(final String optionName, final String description) {
5661
final var option = Option.builder(optionName)
5762
.argName(optionName)
@@ -63,6 +68,12 @@ private void newOneArgOption(final String optionName, final String description)
6368
cliOptions.addOption(option);
6469
}
6570

71+
/**
72+
* Creates a new Apache Commons CLI option with one argument.
73+
* @param optionName name of the option
74+
* @param argName name of the argument to be passed to the option
75+
* @param description option description
76+
*/
6677
private void newArgOption(final String optionName, final String argName, final String description) {
6778
final var option = Option.builder(optionName)
6879
.argName(argName)

0 commit comments

Comments
 (0)