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
commit d2506e332cff2d9102a54678a0ac500d9bd29ca7
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Mar 26 13:44:41 2024 -0400
Javadoc
---
src/main/java/org/apache/commons/cli/Options.java | 18 +++++++-----------
1 file changed, 7 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/Options.java
b/src/main/java/org/apache/commons/cli/Options.java
index 585f543..ca6dbcb 100644
--- a/src/main/java/org/apache/commons/cli/Options.java
+++ b/src/main/java/org/apache/commons/cli/Options.java
@@ -30,9 +30,11 @@ import java.util.Map;
* Main entry-point into the library.
* <p>
* Options represents a collection of {@link Option} objects, which describe
the possible options for a command-line.
+ * </p>
* <p>
* It may flexibly parse long and short options, with or without values.
Additionally, it may parse only a portion of a
* commandline, allowing for flexible multi-stage parsing.
+ * </p>
*
* @see org.apache.commons.cli.CommandLine
*/
@@ -78,8 +80,7 @@ public class Options implements Serializable {
}
/**
- * Add an option that only contains a short-name.
- *
+ * Adds an option that only contains a short-name.
* <p>
* It may be specified as requiring an argument.
* </p>
@@ -95,8 +96,7 @@ public class Options implements Serializable {
}
/**
- * Add an option that only contains a short name.
- *
+ * Adds an option that only contains a short name.
* <p>
* The option does not take an argument.
* </p>
@@ -112,8 +112,7 @@ public class Options implements Serializable {
}
/**
- * Add an option that contains a short-name and a long-name.
- *
+ * Adds an option that contains a short-name and a long-name.
* <p>
* It may be specified as requiring an argument.
* </p>
@@ -130,7 +129,7 @@ public class Options implements Serializable {
}
/**
- * Add the specified option group.
+ * Adds the specified option group.
*
* @param group the OptionGroup that is to be added
* @return the resulting Options instance
@@ -170,12 +169,10 @@ public class Options implements Serializable {
}
/**
- * Add an option that contains a short-name and a long-name.
- *
+ * Adds an option that contains a short-name and a long-name.
* <p>
* The added option is set as required. It may be specified as requiring
an argument. This method is a shortcut for:
* </p>
- *
* <pre>
* <code>
* Options option = new Option(opt, longOpt, hasArg, description);
@@ -222,7 +219,6 @@ public class Options implements Serializable {
/**
* Gets the {@link Option} matching the long or short name specified.
- *
* <p>
* The leading hyphens in the name are ignored (up to 2).
* </p>
