Add Javadoc for selector arguments

This commit is contained in:
Jason Penilla 2022-10-26 11:06:51 -07:00 committed by Jason
parent d403063622
commit 3a0768500b
4 changed files with 32 additions and 0 deletions

View file

@ -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 <C> sender type
*/
public final class MultipleEntitySelectorArgument<C> extends CommandArgument<C, MultipleEntitySelector> {
private MultipleEntitySelectorArgument(

View file

@ -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 <C> sender type
*/
public final class MultiplePlayerSelectorArgument<C> extends CommandArgument<C, MultiplePlayerSelector> {
private MultiplePlayerSelectorArgument(

View file

@ -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 <C> sender type
*/
public final class SingleEntitySelectorArgument<C> extends CommandArgument<C, SingleEntitySelector> {
private SingleEntitySelectorArgument(

View file

@ -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 <C> sender type
*/
public final class SinglePlayerSelectorArgument<C> extends CommandArgument<C, SinglePlayerSelector> {
private SinglePlayerSelectorArgument(