From 39b50244ca9f92e7bfa1fde48a4869ea4a1731ae Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Thu, 3 Apr 2025 00:26:15 +0300 Subject: [PATCH] Better javadoc. --- src/main/java/eu/svjatoslav/commons/cli_helper/CLIHelper.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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) { -- 2.20.1