X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fcommons%2Fcommandline%2Fparameterparser%2FParameter.java;h=67c6af3e3f75fb6318d12be1307b0633b0f713a3;hb=965adace2b47642e2ca84f499cc32683c12059c6;hp=820858365000cac1936e0e68f1afd38d05cde1a4;hpb=7b0d4e85fa892dc8422bfa10ab3b4328bc9f1253;p=svjatoslav_commons.git

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..67c6af3 100755
--- a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
+++ b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
@@ -1,6 +1,6 @@
 /*
  * Svjatoslav Commons - shared library of common functionality.
- * Copyright ©2012-2017, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
+ * Copyright ©2012-2019, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of version 3 of the GNU Lesser General Public License
@@ -15,7 +15,13 @@ import java.util.List;
 
 public abstract class Parameter<T, I extends 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<String> arguments = new ArrayList<>();
     final ArgumentCount argumentCount;
     private final List<String> aliases = new ArrayList<>();
@@ -93,7 +99,10 @@ public abstract class Parameter<T, I extends 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();