From 00701267c86ee89606c9a290ce3ff60bfc724712 Mon Sep 17 00:00:00 2001 From: Pedro <3602279+Doc94@users.noreply.github.com> Date: Sun, 16 Feb 2025 15:19:42 -0300 Subject: [PATCH] [ci skip] improvement example in javadoc for DatapackRegistrar (#12122) --- .../java/io/papermc/paper/datapack/DatapackRegistrar.java | 7 +++++-- .../java/io/papermc/paper/tag/PostFlattenTagRegistrar.java | 4 ++-- .../java/io/papermc/paper/tag/PreFlattenTagRegistrar.java | 4 ++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/paper-api/src/main/java/io/papermc/paper/datapack/DatapackRegistrar.java b/paper-api/src/main/java/io/papermc/paper/datapack/DatapackRegistrar.java index b009df66d..e2f533a82 100644 --- a/paper-api/src/main/java/io/papermc/paper/datapack/DatapackRegistrar.java +++ b/paper-api/src/main/java/io/papermc/paper/datapack/DatapackRegistrar.java @@ -19,11 +19,13 @@ import org.jspecify.annotations.Nullable; * is called anytime the game tries to discover datapacks at any of the * configured locations. This means that if a datapack should stay available to the server, * it must always be discovered whenever this event fires. - *

An example of a plugin loading a datapack from within it's own jar is below

+ *

+ * An example of a plugin loading a datapack from within its own jar is below, + * assuming the datapack is included under {@code resources/pack} folder: *

{@code
  * public class YourPluginBootstrap implements PluginBootstrap {
  *     @Override
- *     public void bootstrap(BoostrapContext context) {
+ *     public void bootstrap(BootstrapContext context) {
  *         final LifecycleEventManager manager = context.getLifecycleManager();
  *         manager.registerEventHandler(LifecycleEvents.DATAPACK_DISCOVERY, event -> {
  *             DatapackRegistrar registrar = event.registrar();
@@ -39,6 +41,7 @@ import org.jspecify.annotations.Nullable;
  *     }
  * }
  * }
+ * * @see io.papermc.paper.plugin.lifecycle.event.types.LifecycleEvents#DATAPACK_DISCOVERY */ @ApiStatus.NonExtendable diff --git a/paper-api/src/main/java/io/papermc/paper/tag/PostFlattenTagRegistrar.java b/paper-api/src/main/java/io/papermc/paper/tag/PostFlattenTagRegistrar.java index 909abcb18..a8d53a1b6 100644 --- a/paper-api/src/main/java/io/papermc/paper/tag/PostFlattenTagRegistrar.java +++ b/paper-api/src/main/java/io/papermc/paper/tag/PostFlattenTagRegistrar.java @@ -19,7 +19,7 @@ import org.jspecify.annotations.NullMarked; * tags only point to individual entries and not other nested tags. *

* An example of a custom enchant being registered to the vanilla - * {@code #minecraft:in_enchanting_table} tag. + * {@code #minecraft:in_enchanting_table} tag: *

{@code
  * class YourBootstrapClass implements PluginBootstrap {
  *
@@ -27,7 +27,7 @@ import org.jspecify.annotations.NullMarked;
  *
  *     @Override
  *     public void bootstrap(BootstrapContext context) {
- *         LifecycleEventManager manager = context.getLifecycleManager();
+ *         final LifecycleEventManager manager = context.getLifecycleManager();
  *         manager.registerEventHandler(LifecycleEvents.TAGS.postFlatten(RegistryKey.ENCHANTMENT), event -> {
  *             final PostFlattenTagRegistrar registrar = event.registrar();
  *             registrar.addToTag(
diff --git a/paper-api/src/main/java/io/papermc/paper/tag/PreFlattenTagRegistrar.java b/paper-api/src/main/java/io/papermc/paper/tag/PreFlattenTagRegistrar.java
index 7c00ad45f..5c42ab605 100644
--- a/paper-api/src/main/java/io/papermc/paper/tag/PreFlattenTagRegistrar.java
+++ b/paper-api/src/main/java/io/papermc/paper/tag/PreFlattenTagRegistrar.java
@@ -22,11 +22,11 @@ import org.jspecify.annotations.NullMarked;
  * 
{@code
  * class YourBootstrapClass implements PluginBootstrap {
  *
- *     public static final TagKey AXE_PICKAXE = TagKey.create(RegistryKey.ITEM, Key.key("papermc:axe_pickaxe"));
+ *     public static final TagKey AXE_PICKAXE = ItemTypeTagKeys.create(Key.key("papermc:axe_pickaxe"));
  *
  *     @Override
  *     public void bootstrap(BootstrapContext context) {
- *         LifecycleEventManager manager = context.getLifecycleManager();
+ *         final LifecycleEventManager manager = context.getLifecycleManager();
  *         manager.registerEventHandler(LifecycleEvents.TAGS.preFlatten(RegistryKey.ITEM), event -> {
  *             final PreFlattenTagRegistrar registrar = event.registrar();
  *             registrar.setTag(AXE_PICKAXE, Set.of(