(commons-cli) branch master updated: Javadoc

[ggregory]

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


The following commit(s) were added to refs/heads/master by this push:
     new 4a9c006  Javadoc
4a9c006 is described below

commit 4a9c00649c7ff5e4ca8dc54f7e27501c3a706abf
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Jun 8 09:15:40 2024 -0400

    Javadoc
---
 src/main/java/org/apache/commons/cli/OptionGroup.java | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/src/main/java/org/apache/commons/cli/OptionGroup.java 
b/src/main/java/org/apache/commons/cli/OptionGroup.java
index 79ae076..82dd5d4 100644
--- a/src/main/java/org/apache/commons/cli/OptionGroup.java
+++ b/src/main/java/org/apache/commons/cli/OptionGroup.java
@@ -41,7 +41,7 @@ public class OptionGroup implements Serializable {
     private boolean required;
 
     /**
-     * Add the specified {@code Option} to this group.
+     * Adds the given {@code Option} to this group.
      *
      * @param option the option to add to this group
      * @return this option group with the option added
@@ -54,7 +54,9 @@ public class OptionGroup implements Serializable {
     }
 
     /**
-     * @return the names of the options in this group as a {@code Collection}
+     * Gets the names of the options in this group as a {@code Collection}.
+     *
+     * @return the names of the options in this group as a {@code Collection}.
      */
     public Collection<String> getNames() {
         // the key set is the collection of names
@@ -62,7 +64,9 @@ public class OptionGroup implements Serializable {
     }
 
     /**
-     * @return the options in this group as a {@code Collection}
+     * Gets the options in this group as a {@code Collection}.
+     *
+     * @return the options in this group as a {@code Collection}.
      */
     public Collection<Option> getOptions() {
         // the values are the collection of options
@@ -70,7 +74,9 @@ public class OptionGroup implements Serializable {
     }
 
     /**
-     * @return the selected option name
+     * Gets the selected option name.
+     *
+     * @return the selected option name.
      */
     public String getSelected() {
         return selected;
@@ -86,7 +92,9 @@ public class OptionGroup implements Serializable {
     }
 
     /**
-     * @param required specifies if this group is required
+     * Sets whether this group is required.
+     *
+     * @param required whether this group is required.
      */
     public void setRequired(final boolean required) {
         this.required = required;