improved 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 fd22c89..25f406d 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
+++ b/src/main/java/eu/svjatoslav/commons/commandline/parameterparser/Parameter.java
@@ -51,6 +51,7 @@ public abstract class Parameter<T> {
                this.argumentCount = argumentCount;
        }
 
+       @SuppressWarnings("unchecked")
        public T addAliases(final String... aliasArray) {
 
                // save aliases
@@ -61,6 +62,8 @@ public abstract class Parameter<T> {
        }
 
        /**
+        * @param argumentString
+        *            argument to add
         * @return <code>true</code> if no errors were found. <code>false</code>
         *         otherwise.
         */
@@ -147,6 +150,8 @@ public abstract class Parameter<T> {
        }
 
        /**
+        * @param alias
+        *            alias to check against
         * @return <code>true</code> if given alias is registered for this
         *         parameter.
         */
@@ -177,6 +182,7 @@ public abstract class Parameter<T> {
                return true;
        }
 
+       @SuppressWarnings("unchecked")
        public T setMandatory() {
                mandatory = true;
                return (T) this;
@@ -191,6 +197,8 @@ public abstract class Parameter<T> {
        }
 
        /**
+        * @param value
+        *            value to validate
         * @return <code>true</code> if value is correct, <code>false</code>
         *         otherwise.
         */