From 3a0768500bb7c0a102c99273f4c9082c7cf75aa5 Mon Sep 17 00:00:00 2001 From: Jason Penilla <11360596+jpenilla@users.noreply.github.com> Date: Wed, 26 Oct 2022 11:06:51 -0700 Subject: [PATCH] Add Javadoc for selector arguments --- .../parsers/selector/MultipleEntitySelectorArgument.java | 8 ++++++++ .../parsers/selector/MultiplePlayerSelectorArgument.java | 8 ++++++++ .../parsers/selector/SingleEntitySelectorArgument.java | 8 ++++++++ .../parsers/selector/SinglePlayerSelectorArgument.java | 8 ++++++++ 4 files changed, 32 insertions(+) diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/MultipleEntitySelectorArgument.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/MultipleEntitySelectorArgument.java index da73809e..7c3a1dec 100644 --- a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/MultipleEntitySelectorArgument.java +++ b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/MultipleEntitySelectorArgument.java @@ -35,6 +35,14 @@ import org.bukkit.entity.Entity; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; +/** + * Argument type for parsing {@link MultipleEntitySelector}. On Minecraft 1.13+ + * this argument uses Minecraft's built-in entity selector argument for parsing + * and suggestions. On prior versions, this argument will suggest nothing and + * always fail parsing with {@link SelectorParseException.FailureReason#UNSUPPORTED_VERSION}. + * + * @param sender type + */ public final class MultipleEntitySelectorArgument extends CommandArgument { private MultipleEntitySelectorArgument( diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/MultiplePlayerSelectorArgument.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/MultiplePlayerSelectorArgument.java index d9863842..220503db 100644 --- a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/MultiplePlayerSelectorArgument.java +++ b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/MultiplePlayerSelectorArgument.java @@ -41,6 +41,14 @@ import org.bukkit.entity.Player; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; +/** + * Argument type for parsing {@link MultiplePlayerSelector}. On Minecraft 1.13+ + * this argument uses Minecraft's built-in entity selector argument for parsing + * and suggestions. On prior versions, this argument behaves similarly to + * {@link PlayerArgument}. + * + * @param sender type + */ public final class MultiplePlayerSelectorArgument extends CommandArgument { private MultiplePlayerSelectorArgument( diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/SingleEntitySelectorArgument.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/SingleEntitySelectorArgument.java index 9dcceb1a..cdaa0a14 100644 --- a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/SingleEntitySelectorArgument.java +++ b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/SingleEntitySelectorArgument.java @@ -34,6 +34,14 @@ import org.apiguardian.api.API; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; +/** + * Argument type for parsing {@link SingleEntitySelector}. On Minecraft 1.13+ + * this argument uses Minecraft's built-in entity selector argument for parsing + * and suggestions. On prior versions, this argument will suggest nothing and + * always fail parsing with {@link SelectorParseException.FailureReason#UNSUPPORTED_VERSION}. + * + * @param sender type + */ public final class SingleEntitySelectorArgument extends CommandArgument { private SingleEntitySelectorArgument( diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/SinglePlayerSelectorArgument.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/SinglePlayerSelectorArgument.java index ee5e209f..c0e5b9c9 100644 --- a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/SinglePlayerSelectorArgument.java +++ b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/selector/SinglePlayerSelectorArgument.java @@ -40,6 +40,14 @@ import org.bukkit.entity.Player; import org.checkerframework.checker.nullness.qual.NonNull; import org.checkerframework.checker.nullness.qual.Nullable; +/** + * Argument type for parsing {@link SinglePlayerSelector}. On Minecraft 1.13+ + * this argument uses Minecraft's built-in entity selector argument for parsing + * and suggestions. On prior versions, this argument behaves similarly to + * {@link PlayerArgument}. + * + * @param sender type + */ public final class SinglePlayerSelectorArgument extends CommandArgument { private SinglePlayerSelectorArgument(