Improve node suggest javadocs

This commit is contained in:
Ben Woo 2023-09-20 23:39:04 +08:00
parent 4084cd4af1
commit f2e193eda3
No known key found for this signature in database
GPG Key ID: FB2A3645536E12C8
2 changed files with 4 additions and 4 deletions

View File

@ -11,9 +11,9 @@ import org.jetbrains.annotations.Nullable;
@FunctionalInterface @FunctionalInterface
public interface NodeSuggester { public interface NodeSuggester {
/** /**
* Suggests possible values for a node value. * Suggests possible values for a node value. Generated based on the current user input.
* *
* @param input The current user input * @param input The current partial user input
* @return The possible values. * @return The possible values.
*/ */
@NotNull Collection<String> suggest(@Nullable String input); @NotNull Collection<String> suggest(@Nullable String input);

View File

@ -33,9 +33,9 @@ public interface ValueNode<T> extends Node {
@Nullable T getDefaultValue(); @Nullable T getDefaultValue();
/** /**
* Suggests possible string values for this node. * Suggests possible string values for this node. Generated based on the current user input.
* *
* @param input The input string. * @param input The current partial user input
* @return A collection of possible string values. * @return A collection of possible string values.
*/ */
@NotNull Collection<String> suggest(@Nullable String input); @NotNull Collection<String> suggest(@Nullable String input);