From: Svjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Date: Wed, 2 Apr 2025 21:26:15 +0000 (+0300)
Subject: Better javadoc.
X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=commitdiff_plain;h=39b50244ca9f92e7bfa1fde48a4869ea4a1731ae;p=cli-helper.git

Better javadoc.
---

diff --git a/src/main/java/eu/svjatoslav/commons/cli_helper/CLIHelper.java b/src/main/java/eu/svjatoslav/commons/cli_helper/CLIHelper.java
index 96fdfab..8d6a856 100755
--- a/src/main/java/eu/svjatoslav/commons/cli_helper/CLIHelper.java
+++ b/src/main/java/eu/svjatoslav/commons/cli_helper/CLIHelper.java
@@ -135,7 +135,8 @@ public class CLIHelper {
      * @param defaultValue the default float if user simply presses Enter (may be {@code null})
      * @param min          the minimum acceptable value (inclusive), or {@code null} if no lower bound
      * @param max          the maximum acceptable value (inclusive), or {@code null} if no upper bound
-     * @param allowEmpty   if {@code true}, empty input returns {@code null} when {@code defaultValue} is null
+     * @param allowEmpty   if {@code true}, empty input returns {@code null} when {@code defaultValue} is null.
+     *                     When defaultValue is not null, allowEmpty has no effect.
      * @return a {@code Float} value entered by the user, or {@code defaultValue}, or {@code null}
      */
     public static Float askFloat(String prompt, Float defaultValue, Float min, Float max, boolean allowEmpty) {