X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fcommons%2Fcommandline%2Fparameterparser%2FParameter.java;h=bc8db0e9b40c5c28743d51c1de1ac48ffe72f0a8;hp=820858365000cac1936e0e68f1afd38d05cde1a4;hb=57ac589c5bb0860921e6f75e26a76958b76ac244;hpb=95e6875c60d90e9515fa5a0569f613ad716ab04e diff --git a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java index 8208583..bc8db0e 100755 --- a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java +++ b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java @@ -15,7 +15,13 @@ import java.util.List; public abstract class Parameter { + /** + * Purpose of this argument, like: input image path, compression level, etc... + * + * Note: for describing argument type (file, integer, ...) there is {@link #describeFormat()}. + */ public final String description; + public final List arguments = new ArrayList<>(); final ArgumentCount argumentCount; private final List aliases = new ArrayList<>(); @@ -93,7 +99,10 @@ public abstract class Parameter { } /** - * @return Single line argument type description. + * @return Single line argument type description. If argument type should be file, + * date, integer, regular expression, etc.. + * + * Note: for argument purpose description there is {@link #description} */ public abstract String describeFormat();