Add Javadoc comments to enhance code clarity

[cli-helper.git] / src / main / java / eu / svjatoslav / commons / cli_helper / parameter_parser / parameter / StringOption.java

diff --git a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/StringOption.java b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/StringOption.java
index 7ba7c93..d7cb3e7 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/StringOption.java
+++ b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/StringOption.java
@@ -7,23 +7,27 @@ package eu.svjatoslav.commons.cli_helper.parameter_parser.parameter;
 import eu.svjatoslav.commons.cli_helper.parameter_parser.ParameterCount;
 import eu.svjatoslav.commons.cli_helper.parameter_parser.Option;
 
+/**
+ * This class represents commandline option which accepts exactly one parameter
+ * which is a string.
+ */
 public class StringOption extends Option<String, StringOption> {
 
     public final String defaultValue;
 
     public StringOption(final String description) {
-        super(description, ParameterCount.SINGLE);
+        super(description, ParameterCount.ONE);
         defaultValue = null;
     }
     public StringOption(final String description, String defaultValue) {
-        super(description, ParameterCount.SINGLE);
+        super(description, ParameterCount.ONE);
         this.defaultValue = defaultValue;
         this.setPresent(true);
     }
 
     @Override
     public java.lang.String describeFormat() {
-        return "string";
+        return "String.";
     }
 
     @Override