projects
/
svjatoslav_commons.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Added clarifying javadoc.
[svjatoslav_commons.git]
/
src
/
main
/
java
/
eu
/
svjatoslav
/
commons
/
commandline
/
parameterparser
/
Parameter.java
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
(executable)
--- 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> {
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 String description;
+
public final List<String> arguments = new ArrayList<>();
final ArgumentCount argumentCount;
private final List<String> aliases = new ArrayList<>();
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();
*/
public abstract String describeFormat();