improved javadoc

[svjatoslav_commons.git] / src / main / java / eu / svjatoslav / commons / commandline / CLIHelper.java

diff --git a/src/main/java/eu/svjatoslav/commons/commandline/CLIHelper.java b/src/main/java/eu/svjatoslav/commons/commandline/CLIHelper.java
index a3764a1..5a774e2 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/commandline/CLIHelper.java
+++ b/src/main/java/eu/svjatoslav/commons/commandline/CLIHelper.java
@@ -1,7 +1,7 @@
 /*
  * Svjatoslav Commons - shared library of common functionality.
  * Copyright ©2012-2014, 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
  * or later as published by the Free Software Foundation.
@@ -20,6 +20,10 @@ public class CLIHelper {
 
        /**
         * Ask boolean value from user on command-line.
+        *
+        * @param prompt
+        *            to show to the user
+        * @return <code>true</code> is user answered affirmative.
         */
        public static boolean askBoolean(final String prompt) {
 
@@ -49,6 +53,10 @@ public class CLIHelper {
 
        /**
         * Ask numerical long value from user on command-line.
+        *
+        * @param prompt
+        *            to show to the user
+        * @return value given by user
         */
        public static long askLong(final String prompt) {
 
@@ -76,6 +84,10 @@ public class CLIHelper {
 
        /**
         * Ask string value from user on command-line.
+        * 
+        * @param prompt
+        *            to show to the user
+        * @return value given by the user
         */
        public static String askString(final String prompt) {