Javadoc

Author: garydgregory

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,23 +54,29 @@ public OptionGroup addOption(final Option option) {
     }
 
     /**
-     * @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
         return optionMap.keySet();
     }
 
     /**
-     * @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
         return optionMap.values();
     }
 
     /**
-     * @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 boolean isRequired() {
     }
 
     /**
-     * @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;