Add Javadoc comments to enhance code clarity

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

diff --git a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/NullOption.java b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/NullOption.java
index a220ab3..9b5ad88 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/NullOption.java
+++ b/src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/NullOption.java
@@ -7,6 +7,9 @@ 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 zero parameters.
+ */
 public class NullOption extends Option<Boolean, NullOption> {
 
     public NullOption(final String description) {
@@ -15,7 +18,7 @@ public class NullOption extends Option<Boolean, NullOption> {
 
     @Override
     public java.lang.String describeFormat() {
-        return "<none>";
+        return "None.";
     }
 
     @Override