zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

📚 Improve CommandSyntaxFormatter documentation

Browse source
This commit is contained in:
Alexander Söderberg 2021-01-14 08:37:34 +01:00 • committed by Alexander Söderberg
parent 2cf743c805
commit 14baf5b876
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
cloud-core/src/main/java/cloud/commandframework/arguments/CommandSyntaxFormatter.java
View file

@ -40,9 +40,13 @@ public interface CommandSyntaxFormatter<C> {
/** /**
* Format the command arguments into a syntax string * Format the command arguments into a syntax string
* *
* @param commandArguments Command arguments * @param commandArguments Command arguments that have been unambiguously specified up until this point. This
* @param node Trailing node * should include the "current" command, if such a command exists.
* @return Syntax string * @param node The current command node. The children of this node will be appended onto the
* command syntax string, as long as an unambiguous path can be identified. The node
* itself will not be appended onto the syntax string. This can be set to {@code null} if
* no node is relevant at the point of formatting.
* @return The formatted syntax string
*/ */
@NonNull String apply( @NonNull String apply(
@NonNull List<@NonNull CommandArgument<C, ?>> commandArguments, @NonNull List<@NonNull CommandArgument<C, ?>> commandArguments,