From 57ac589c5bb0860921e6f75e26a76958b76ac244 Mon Sep 17 00:00:00 2001
From: Svjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Date: Tue, 26 Dec 2017 21:06:36 +0200
Subject: [PATCH] Added clarifying javadoc.

---
 .../commandline/parameterparser/Parameter.java        | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

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<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();
 
-- 
2.20.1