From 3f070e5a3839cf78b753842f1a14b8c278ab03a6 Mon Sep 17 00:00:00 2001 From: Jason Penilla <11360596+jpenilla@users.noreply.github.com> Date: Sun, 21 Jan 2024 11:12:42 -0700 Subject: [PATCH] Javadoc fixes --- .../sponge/SpongeParserMapper.java | 4 ++-- .../sponge/parser/BlockInputParser.java | 8 ++++++- .../sponge/parser/BlockPredicateParser.java | 8 ++++++- .../sponge/parser/ComponentParser.java | 8 ++++++- .../sponge/parser/DataContainerParser.java | 8 ++++++- .../parser/GameProfileCollectionParser.java | 8 ++++++- .../sponge/parser/GameProfileParser.java | 8 ++++++- .../parser/ItemStackPredicateParser.java | 8 ++++++- .../parser/MultipleEntitySelectorParser.java | 8 ++++++- .../parser/MultiplePlayerSelectorParser.java | 8 ++++++- .../sponge/parser/NamedTextColorParser.java | 8 ++++++- .../sponge/parser/OperatorParser.java | 8 ++++++- .../sponge/parser/ProtoItemStackParser.java | 8 ++++++- .../sponge/parser/RegistryEntryParser.java | 22 +++++++++---------- .../sponge/parser/ResourceKeyParser.java | 8 ++++++- .../parser/SingleEntitySelectorParser.java | 8 ++++++- .../parser/SinglePlayerSelectorParser.java | 8 ++++++- .../sponge/parser/UserParser.java | 8 ++++++- .../sponge/parser/Vector2dParser.java | 15 ++++++++++++- .../sponge/parser/Vector2iParser.java | 8 ++++++- .../sponge/parser/Vector3dParser.java | 15 ++++++++++++- .../sponge/parser/Vector3iParser.java | 8 ++++++- .../sponge/parser/VectorParser.java | 2 +- .../sponge/parser/WorldParser.java | 8 ++++++- examples/example-sponge/build.gradle.kts | 2 +- 25 files changed, 176 insertions(+), 36 deletions(-) diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/SpongeParserMapper.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/SpongeParserMapper.java index df3e13e4..5041226c 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/SpongeParserMapper.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/SpongeParserMapper.java @@ -53,7 +53,7 @@ * Class responsible for mapping Cloud {@link ArgumentParser ArgumentParsers} to Sponge * {@link CommandTreeNode.Argument CommandTreeNode.Arguments}. * - * @param sender type + * @param command sender type */ public final class SpongeParserMapper { @@ -257,7 +257,7 @@ public void cloudNumberSuggestions(final boolean cloudNumberSuggestions) { * Builder for mappings from Cloud {@link ArgumentParser ArgumentParsers} to Sponge * {@link CommandTreeNode.Argument CommandTreeNode.Arguments} * - * @param sender type + * @param command sender type * @param parser type */ public interface MappingBuilder> { diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/BlockInputParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/BlockInputParser.java index fd293a02..1adf3c02 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/BlockInputParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/BlockInputParser.java @@ -63,10 +63,16 @@ *
  • {@code andesite_stairs[waterlogged=true,facing=east]}
  • * * - * @param sender type + * @param command sender type */ public final class BlockInputParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link BlockInputParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor blockInputParser() { return ParserDescriptor.of(new BlockInputParser<>(), BlockInput.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/BlockPredicateParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/BlockPredicateParser.java index 967ad017..9b150177 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/BlockPredicateParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/BlockPredicateParser.java @@ -49,11 +49,17 @@ /** * An argument for parsing {@link BlockPredicate BlockPredicates}. * - * @param sender type + * @param command sender type */ public final class BlockPredicateParser implements ArgumentParser.FutureArgumentParser, NodeSource, SuggestionProvider { + /** + * Creates a new {@link BlockPredicateParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor blockPredicateParser() { return ParserDescriptor.of(new BlockPredicateParser<>(), BlockPredicate.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ComponentParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ComponentParser.java index 44e3bc8b..1b678970 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ComponentParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ComponentParser.java @@ -42,10 +42,16 @@ /** * An argument for parsing {@link Component Components} from json formatted text. * - * @param sender type + * @param command sender type */ public final class ComponentParser implements ArgumentParser.FutureArgumentParser, NodeSource, SuggestionProvider { + /** + * Creates a new {@link ComponentParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor componentParser() { return ParserDescriptor.of(new ComponentParser<>(), Component.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/DataContainerParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/DataContainerParser.java index 645ecd9e..65138a4f 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/DataContainerParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/DataContainerParser.java @@ -45,11 +45,17 @@ * Argument for parsing {@link DataContainer DataContainers} from *
    SNBT strings. * - * @param sender type + * @param command sender type */ public final class DataContainerParser implements ArgumentParser.FutureArgumentParser, NodeSource, SuggestionProvider { + /** + * Creates a new {@link DataContainerParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor dataContainerParser() { return ParserDescriptor.of(new DataContainerParser<>(), DataContainer.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/GameProfileCollectionParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/GameProfileCollectionParser.java index 7b830ca6..32d4f3c5 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/GameProfileCollectionParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/GameProfileCollectionParser.java @@ -56,11 +56,17 @@ * Argument for parsing a {@link Collection} of {@link GameProfile GameProfiles} from a * {@link Selector}. A successfully parsed result will contain at least one element. * - * @param sender type + * @param command sender type */ public final class GameProfileCollectionParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link GameProfileCollectionParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor gameProfileCollectionParser() { return ParserDescriptor.of(new GameProfileCollectionParser<>(), GameProfileCollection.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/GameProfileParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/GameProfileParser.java index c25705c8..c0773b16 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/GameProfileParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/GameProfileParser.java @@ -49,10 +49,16 @@ /** * Argument for parsing a single {@link GameProfile} from a {@link Selector}. * - * @param sender type + * @param command sender type */ public final class GameProfileParser implements ArgumentParser.FutureArgumentParser, NodeSource, SuggestionProvider { + /** + * Creates a new {@link GameProfileParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor gameProfileParser() { return ParserDescriptor.of(new GameProfileParser<>(), GameProfile.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ItemStackPredicateParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ItemStackPredicateParser.java index 8876640d..2ec11036 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ItemStackPredicateParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ItemStackPredicateParser.java @@ -49,11 +49,17 @@ /** * An argument for parsing {@link ItemStackPredicate ItemStackPredicates}. * - * @param sender type + * @param command sender type */ public final class ItemStackPredicateParser implements ArgumentParser.FutureArgumentParser, NodeSource, SuggestionProvider { + /** + * Creates a new {@link ItemStackPredicateParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor itemStackPredicateParser() { return ParserDescriptor.of(new ItemStackPredicateParser<>(), ItemStackPredicate.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/MultipleEntitySelectorParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/MultipleEntitySelectorParser.java index dc049c1b..c44a71e5 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/MultipleEntitySelectorParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/MultipleEntitySelectorParser.java @@ -51,11 +51,17 @@ /** * Argument for selecting one or more {@link Entity Entities} using a {@link Selector}. * - * @param sender type + * @param command sender type */ public final class MultipleEntitySelectorParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link MultipleEntitySelectorParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor multipleEntitySelectorParser() { return ParserDescriptor.of(new MultipleEntitySelectorParser<>(), MultipleEntitySelector.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/MultiplePlayerSelectorParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/MultiplePlayerSelectorParser.java index affb60f2..15f8c578 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/MultiplePlayerSelectorParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/MultiplePlayerSelectorParser.java @@ -52,11 +52,17 @@ /** * Argument for selecting one or more {@link Player Players} using a {@link Selector}. * - * @param sender type + * @param command sender type */ public final class MultiplePlayerSelectorParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link MultiplePlayerSelectorParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor multiplePlayerSelectorParser() { return ParserDescriptor.of(new MultiplePlayerSelectorParser<>(), MultiplePlayerSelector.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/NamedTextColorParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/NamedTextColorParser.java index 6efb2873..6aea7215 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/NamedTextColorParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/NamedTextColorParser.java @@ -41,10 +41,16 @@ /** * An argument for parsing {@link NamedTextColor NamedTextColors}. * - * @param sender type + * @param command sender type */ public final class NamedTextColorParser implements NodeSource, ArgumentParser, BlockingSuggestionProvider.Strings { + /** + * Creates a new {@link NamedTextColorParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor namedTextColorParser() { return ParserDescriptor.of(new NamedTextColorParser<>(), NamedTextColor.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/OperatorParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/OperatorParser.java index 6188b6c5..f6ca6caa 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/OperatorParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/OperatorParser.java @@ -43,10 +43,16 @@ /** * An argument for parsing {@link Operator Operators}. * - * @param sender type + * @param command sender type */ public final class OperatorParser implements NodeSource, ArgumentParser, BlockingSuggestionProvider.Strings { + /** + * Creates a new {@link OperatorParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor operatorParser() { return ParserDescriptor.of(new OperatorParser<>(), Operator.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ProtoItemStackParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ProtoItemStackParser.java index d4562df3..1a0570aa 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ProtoItemStackParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ProtoItemStackParser.java @@ -63,11 +63,17 @@ *
  • {@code diamond_sword{Enchantments:[{id:sharpness,lvl:5}]}}
  • * * - * @param sender type + * @param command sender type */ public final class ProtoItemStackParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link ProtoItemStackParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor protoItemStackParser() { return ParserDescriptor.of(new ProtoItemStackParser<>(), ProtoItemStack.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/RegistryEntryParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/RegistryEntryParser.java index c5557d33..61b699ea 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/RegistryEntryParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/RegistryEntryParser.java @@ -55,7 +55,7 @@ /** * An argument for retrieving values from any of Sponge's {@link Registry Registries}. * - * @param sender type + * @param command sender type * @param value type */ public final class RegistryEntryParser implements NodeSource, @@ -64,12 +64,12 @@ public final class RegistryEntryParser implements NodeSource, // Start DefaultedRegistryType methods /** - * Create a new required {@link RegistryEntryParser} for a {@link DefaultedRegistryType}. + * Create a new {@link RegistryEntryParser} for a {@link DefaultedRegistryType}. * + * @param command sender type + * @param value type * @param valueType value type * @param registryType registry type - * @param sender type - * @param value type * @return a new {@link RegistryEntryParser} */ public static @NonNull ParserDescriptor registryEntryParser( @@ -80,12 +80,12 @@ public final class RegistryEntryParser implements NodeSource, } /** - * Create a new required {@link RegistryEntryParser} for a {@link DefaultedRegistryType}. + * Create a new {@link RegistryEntryParser} for a {@link DefaultedRegistryType}. * + * @param command sender type + * @param value type * @param valueType value type * @param registryType registry type - * @param sender type - * @param value type * @return a new {@link RegistryEntryParser} */ public static @NonNull ParserDescriptor registryEntryParser( @@ -100,13 +100,13 @@ public final class RegistryEntryParser implements NodeSource, // Start RegistryType methods /** - * Create a new required {@link RegistryEntryParser} for a {@link RegistryType} + * Create a new {@link RegistryEntryParser} for a {@link RegistryType} * using the specified {@link RegistryHolder} function. * *

    For {@link RegistryType RegistryTypes} which are {@link DefaultedRegistryType DefaultedRegistryTypes}, * it is suggested to instead use {@link #registryEntryParser(TypeToken, DefaultedRegistryType)}.

    * - * @param sender type + * @param command sender type * @param value type * @param valueType value type * @param registryType registry type @@ -122,13 +122,13 @@ public final class RegistryEntryParser implements NodeSource, } /** - * Create a new required {@link RegistryEntryParser} for a {@link RegistryType} + * Create a new {@link RegistryEntryParser} for a {@link RegistryType} * using the specified {@link RegistryHolder} function. * *

    For {@link RegistryType RegistryTypes} which are {@link DefaultedRegistryType DefaultedRegistryTypes}, * it is suggested to instead use {@link #registryEntryParser(TypeToken, DefaultedRegistryType)}.

    * - * @param sender type + * @param command sender type * @param value type * @param valueType value type * @param registryType registry type diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ResourceKeyParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ResourceKeyParser.java index d1824517..6fdabe2b 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ResourceKeyParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/ResourceKeyParser.java @@ -37,10 +37,16 @@ /** * Argument for parsing {@link ResourceKey ResourceKeys}. * - * @param sender type + * @param command sender type */ public final class ResourceKeyParser implements NodeSource, ArgumentParser { + /** + * Creates a new {@link ResourceKeyParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor resourceKeyParser() { return ParserDescriptor.of(new ResourceKeyParser<>(), ResourceKey.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/SingleEntitySelectorParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/SingleEntitySelectorParser.java index 21204db4..a1317cef 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/SingleEntitySelectorParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/SingleEntitySelectorParser.java @@ -48,11 +48,17 @@ /** * Argument for selecting a single {@link Entity} using a {@link Selector}. * - * @param sender type + * @param command sender type */ public final class SingleEntitySelectorParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link SingleEntitySelectorParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor singleEntitySelectorParser() { return ParserDescriptor.of(new SingleEntitySelectorParser<>(), SingleEntitySelector.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/SinglePlayerSelectorParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/SinglePlayerSelectorParser.java index 057a70b7..4c6c374a 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/SinglePlayerSelectorParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/SinglePlayerSelectorParser.java @@ -49,11 +49,17 @@ /** * Argument for selecting a single {@link Player} using a {@link Selector}. * - * @param sender type + * @param command sender type */ public final class SinglePlayerSelectorParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link SinglePlayerSelectorParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor singlePlayerSelectorParser() { return ParserDescriptor.of(new SinglePlayerSelectorParser<>(), SinglePlayerSelector.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/UserParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/UserParser.java index 98c30947..e30fd408 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/UserParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/UserParser.java @@ -62,10 +62,16 @@ * Argument for parsing {@link User} {@link UUID UUIDs} in the {@link UserManager} from * a {@link Selector}, last known username, or {@link UUID} string. * - * @param sender type + * @param command sender type */ public final class UserParser implements NodeSource, ArgumentParser, SuggestionProvider { + /** + * Creates a new {@link UserParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor userParser() { return ParserDescriptor.of(new UserParser<>(), UUID.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector2dParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector2dParser.java index 7e54ba8b..5a970706 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector2dParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector2dParser.java @@ -51,14 +51,27 @@ *
  • {@code ~1 ~-2}
  • * * - * @param sender type + * @param command sender type */ public final class Vector2dParser extends VectorParser { + /** + * Creates a new {@link Vector2dParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor vector2dParser() { return vector2dParser(false); } + /** + * Creates a new {@link Vector2dParser}. + * + * @param command sender type + * @param centerIntegers whether to center integers to x.5 + * @return new parser + */ public static ParserDescriptor vector2dParser(final boolean centerIntegers) { return ParserDescriptor.of(new Vector2dParser<>(centerIntegers), Vector2d.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector2iParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector2iParser.java index aacd6de4..9840a949 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector2iParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector2iParser.java @@ -55,10 +55,16 @@ *
  • {@code ^ ^}
  • * * - * @param sender type + * @param command sender type */ public final class Vector2iParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link Vector2iParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor vector2iParser() { return ParserDescriptor.of(new Vector2iParser<>(), Vector2i.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector3dParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector3dParser.java index 4b9a92df..5a5deb57 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector3dParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector3dParser.java @@ -52,14 +52,27 @@ *
  • {@code ^1 ^ ^-5}
  • * * - * @param sender type + * @param command sender type */ public final class Vector3dParser extends VectorParser { + /** + * Creates a new {@link Vector3dParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor vector3dParser() { return vector3dParser(false); } + /** + * Creates a new {@link Vector3dParser}. + * + * @param command sender type + * @param centerIntegers whether to center integers to x.5 + * @return new parser + */ public static ParserDescriptor vector3dParser(final boolean centerIntegers) { return ParserDescriptor.of(new Vector3dParser<>(centerIntegers), Vector3d.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector3iParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector3iParser.java index 9ddf6a79..a470638d 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector3iParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/Vector3iParser.java @@ -54,10 +54,16 @@ *
  • {@code ^1 ^ ^-5}
  • * * - * @param sender type + * @param command sender type */ public final class Vector3iParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { + /** + * Creates a new {@link Vector3iParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor vector3iParser() { return ParserDescriptor.of(new Vector3iParser<>(), Vector3i.class); } diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/VectorParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/VectorParser.java index 5d31f30b..94e3cc30 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/VectorParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/VectorParser.java @@ -32,7 +32,7 @@ * *

    Not for extension by API users.

    * - * @param sender type + * @param command sender type * @param vector type */ public abstract class VectorParser implements NodeSource, ArgumentParser.FutureArgumentParser, SuggestionProvider { diff --git a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/WorldParser.java b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/WorldParser.java index 5f0d331b..4eebe6ed 100644 --- a/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/WorldParser.java +++ b/cloud-sponge/src/main/java/cloud/commandframework/sponge/parser/WorldParser.java @@ -49,10 +49,16 @@ /** * Argument for retrieving {@link ServerWorld ServerWorlds} from the {@link WorldManager} by their {@link ResourceKey}. * - * @param sender type + * @param command sender type */ public final class WorldParser implements ArgumentParser, NodeSource, BlockingSuggestionProvider.Strings { + /** + * Creates a new {@link WorldParser}. + * + * @param command sender type + * @return new parser + */ public static ParserDescriptor worldParser() { return ParserDescriptor.of(new WorldParser<>(), ServerWorld.class); } diff --git a/examples/example-sponge/build.gradle.kts b/examples/example-sponge/build.gradle.kts index 75faa946..f5f2a0ec 100644 --- a/examples/example-sponge/build.gradle.kts +++ b/examples/example-sponge/build.gradle.kts @@ -2,7 +2,7 @@ import org.spongepowered.gradle.plugin.config.PluginLoaders import org.spongepowered.plugin.metadata.model.PluginDependency plugins { - id("org.spongepowered.gradle.plugin") version "2.1.1" + id("org.spongepowered.gradle.plugin") version "2.2.0" alias(libs.plugins.shadow) }