From d642763d9fde36ec52ca7a5efd71ed96000373bf Mon Sep 17 00:00:00 2001 From: maityyy <47220489+maityyy@users.noreply.github.com> Date: Sun, 16 Nov 2025 16:38:05 +0300 Subject: [PATCH] Some javadoc fixes (#5003) * Fix javadoc typo * Tweak * Oops * Oops2 --- .../fabricmc/fabric/api/lookup/v1/block/BlockApiLookup.java | 2 +- .../fabric/api/lookup/v1/entity/EntityApiLookup.java | 2 +- .../fabricmc/fabric/api/lookup/v1/item/ItemApiLookup.java | 2 +- .../fabric/api/command/v2/EntitySelectorOptionRegistry.java | 2 +- .../fabricmc/fabric/api/gamerule/v1/GameRuleBuilder.java | 2 +- .../fabricmc/fabric/api/itemgroup/v1/FabricItemGroup.java | 2 +- .../client/model/loading/v1/SimpleUnbakedExtraModel.java | 2 +- .../builder/v1/entity/FabricDefaultAttributeRegistry.java | 2 +- .../api/object/builder/v1/trade/TradeOfferHelper.java | 4 ++-- .../fabric/api/particle/v1/FabricParticleTypes.java | 4 ++-- .../fabric/api/event/registry/DynamicRegistries.java | 2 +- .../fabric/api/event/registry/FabricRegistryBuilder.java | 2 +- .../v1/LivingEntityFeatureRendererRegistrationCallback.java | 4 ++-- .../api/screenhandler/v1/ExtendedScreenHandlerType.java | 6 +++--- .../fabric/api/client/sound/v1/FabricSoundInstance.java | 2 +- 15 files changed, 20 insertions(+), 20 deletions(-) diff --git a/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/block/BlockApiLookup.java b/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/block/BlockApiLookup.java index e545edc9e0..7b4acc0849 100644 --- a/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/block/BlockApiLookup.java +++ b/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/block/BlockApiLookup.java @@ -51,7 +51,7 @@ import net.fabricmc.fabric.impl.lookup.block.BlockApiLookupImpl; * *
{@code
  * public final class MyApi {
- *     public static final BlockApiLookup FLUID_CONTAINER = BlockApiLookup.get(Identifier.of("mymod", "fluid_container"), FluidContainer.class, Direction.class);
+ *     public static final BlockApiLookup FLUID_CONTAINER = BlockApiLookup.get(Identifier.fromNamespaceAndPath("modid", "fluid_container"), FluidContainer.class, Direction.class);
  * }}
* Using that, we can query instances of {@code FluidContainer}: * diff --git a/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/entity/EntityApiLookup.java b/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/entity/EntityApiLookup.java index 8642a430e0..36c670ac22 100644 --- a/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/entity/EntityApiLookup.java +++ b/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/entity/EntityApiLookup.java @@ -45,7 +45,7 @@ import net.fabricmc.fabric.impl.lookup.entity.EntityApiLookupImpl; *

We need to create the EntityApiLookup. We don't need any context so we use {@link Void}. *

{@code
  * public class MyApi {
- *     public static final EntityApiLookup LEVELED_ENTITY = EntityApiLookup.get(Identifier.of("mymod", "leveled_entity"), Leveled.class, Void.class);
+ *     public static final EntityApiLookup LEVELED_ENTITY = EntityApiLookup.get(Identifier.fromNamespaceAndPath("modid", "leveled_entity"), Leveled.class, Void.class);
  * }
  * }
* diff --git a/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/item/ItemApiLookup.java b/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/item/ItemApiLookup.java index e2f9b2e432..ac5da619f8 100644 --- a/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/item/ItemApiLookup.java +++ b/fabric-api-lookup-api-v1/src/main/java/net/fabricmc/fabric/api/lookup/v1/item/ItemApiLookup.java @@ -47,7 +47,7 @@ import net.fabricmc.fabric.impl.lookup.item.ItemApiLookupImpl; * *
{@code
  * public final class MyApi {
- *     public static final ItemApiLookup FLUID_CONTAINER_ITEM = ItemApiLookup.get(Identifier.of("mymod", "fluid_container"), FluidContainer.class, Void.class);
+ *     public static final ItemApiLookup FLUID_CONTAINER_ITEM = ItemApiLookup.get(Identifier.fromNamespaceAndPath("modid", "fluid_container"), FluidContainer.class, Void.class);
  * }}
* API instances are easy to access: * diff --git a/fabric-command-api-v2/src/main/java/net/fabricmc/fabric/api/command/v2/EntitySelectorOptionRegistry.java b/fabric-command-api-v2/src/main/java/net/fabricmc/fabric/api/command/v2/EntitySelectorOptionRegistry.java index b7f14cffab..ed98300727 100644 --- a/fabric-command-api-v2/src/main/java/net/fabricmc/fabric/api/command/v2/EntitySelectorOptionRegistry.java +++ b/fabric-command-api-v2/src/main/java/net/fabricmc/fabric/api/command/v2/EntitySelectorOptionRegistry.java @@ -40,7 +40,7 @@ public final class EntitySelectorOptionRegistry { * {@code example_min_health} and can be used like {@code @e[example_min_health=5]}. *
{@code
 	 * EntitySelectorOptionRegistry.register(
-	 * 	Identifier.of("example", "min_health"),
+	 * 	Identifier.fromNamespaceAndPath("modid", "min_health"),
 	 * 	Text.literal("Minimum entity health"),
 	 * 	(reader) -> {
 	 * 	    final float minHealth = reader.getReader().readFloat();
diff --git a/fabric-game-rule-api-v1/src/main/java/net/fabricmc/fabric/api/gamerule/v1/GameRuleBuilder.java b/fabric-game-rule-api-v1/src/main/java/net/fabricmc/fabric/api/gamerule/v1/GameRuleBuilder.java
index f0d8f637ca..7a19559a02 100644
--- a/fabric-game-rule-api-v1/src/main/java/net/fabricmc/fabric/api/gamerule/v1/GameRuleBuilder.java
+++ b/fabric-game-rule-api-v1/src/main/java/net/fabricmc/fabric/api/gamerule/v1/GameRuleBuilder.java
@@ -52,7 +52,7 @@ import net.fabricmc.fabric.impl.gamerule.rpc.FabricGameRuleType;
  * 

To register a game rule, you can use {@link GameRuleBuilder#buildAndRegister(Identifier)}. * For example, to register a game rule that is an integer where the default value is 1 and the acceptable values are between 0 and 10, one would use the following: *

- * public static final GameRule<Integer> EXAMPLE_INT_RULE = GameRuleBuilder.forInteger(1).clamped(0, 10).buildAndRegister(Identifier.of(MOD_ID, "example_int_rule"));
+ * public static final GameRule<Integer> EXAMPLE_INT_RULE = GameRuleBuilder.forInteger(1).range(0, 10).buildAndRegister(Identifier.fromNamespaceAndPath("modid", "custom_int_gamerule"));
  * 
* *

To register a game rule in a custom category, call {@link GameRuleBuilder#category(CustomGameRuleCategory)} on the builder. diff --git a/fabric-item-group-api-v1/src/main/java/net/fabricmc/fabric/api/itemgroup/v1/FabricItemGroup.java b/fabric-item-group-api-v1/src/main/java/net/fabricmc/fabric/api/itemgroup/v1/FabricItemGroup.java index 84c2fb69d2..089806038e 100644 --- a/fabric-item-group-api-v1/src/main/java/net/fabricmc/fabric/api/itemgroup/v1/FabricItemGroup.java +++ b/fabric-item-group-api-v1/src/main/java/net/fabricmc/fabric/api/itemgroup/v1/FabricItemGroup.java @@ -40,7 +40,7 @@ public final class FabricItemGroup { *

Example: * *

{@code
-	 * private static final RegistryKey ITEM_GROUP = RegistryKey.of(RegistryKeys.ITEM_GROUP, Identifier.of(MOD_ID, "test_group"));
+	 * private static final RegistryKey ITEM_GROUP = RegistryKey.of(RegistryKeys.ITEM_GROUP, Identifier.fromNamespaceAndPath("modid", "custom_group"));
 	 *
 	 * @Override
 	 * public void onInitialize() {
diff --git a/fabric-model-loading-api-v1/src/client/java/net/fabricmc/fabric/api/client/model/loading/v1/SimpleUnbakedExtraModel.java b/fabric-model-loading-api-v1/src/client/java/net/fabricmc/fabric/api/client/model/loading/v1/SimpleUnbakedExtraModel.java
index ce0de5d9a0..a23028ce6d 100644
--- a/fabric-model-loading-api-v1/src/client/java/net/fabricmc/fabric/api/client/model/loading/v1/SimpleUnbakedExtraModel.java
+++ b/fabric-model-loading-api-v1/src/client/java/net/fabricmc/fabric/api/client/model/loading/v1/SimpleUnbakedExtraModel.java
@@ -51,7 +51,7 @@ public final class SimpleUnbakedExtraModel implements UnbakedExtraModel {
 	 *
 	 * 

Example

* {@snippet : - * public static final Identifier MODEL_ID = Identifier.of("mod_id", "model_path"); + * public static final Identifier MODEL_ID = Identifier.fromNamespaceAndPath("modid", "model_path"); * public static final ExtraModelKey MODEL_KEY = ExtraModelKey.create(MODEL_ID::toString); * * public static void register() { diff --git a/fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/entity/FabricDefaultAttributeRegistry.java b/fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/entity/FabricDefaultAttributeRegistry.java index 3a06e3b277..767609643c 100644 --- a/fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/entity/FabricDefaultAttributeRegistry.java +++ b/fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/entity/FabricDefaultAttributeRegistry.java @@ -64,7 +64,7 @@ public final class FabricDefaultAttributeRegistry { * *

It can be used in a fashion similar to this: *

-	 * EntityAttributeRegistry.INSTANCE.register(type, LivingEntity.createLivingAttributes());
+	 * FabricDefaultAttributeRegistry.register(type, LivingEntity.createLivingAttributes());
 	 * 
*

* diff --git a/fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/trade/TradeOfferHelper.java b/fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/trade/TradeOfferHelper.java index e6eeabdc84..cae7c6a4a2 100644 --- a/fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/trade/TradeOfferHelper.java +++ b/fabric-object-builder-api-v1/src/main/java/net/fabricmc/fabric/api/object/builder/v1/trade/TradeOfferHelper.java @@ -41,7 +41,7 @@ public final class TradeOfferHelper { * *

Below is an example, of registering a trade offer factory to be added a blacksmith with a profession level of 3: *

-	 * TradeOfferHelper.registerVillagerOffers(VillagerProfession.BLACKSMITH, 3, factories -> {
+	 * TradeOfferHelper.registerVillagerOffers(VillagerProfession.WEAPONSMITH, 3, factories -> {
 	 * 	factories.add(new CustomTradeFactory(...);
 	 * });
 	 * 
@@ -63,7 +63,7 @@ public final class TradeOfferHelper { * *

Below is an example, of registering a trade offer factory to be added a blacksmith with a profession level of 3: *

-	 * TradeOfferHelper.registerVillagerOffers(VillagerProfession.BLACKSMITH, 3, (factories, rebalanced) -> {
+	 * TradeOfferHelper.registerVillagerOffers(VillagerProfession.WEAPONSMITH, 3, (factories, rebalanced) -> {
 	 * 	factories.add(new CustomTradeFactory(...);
 	 * });
 	 * 
diff --git a/fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricParticleTypes.java b/fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricParticleTypes.java index d38573ac34..ee53e1e39e 100644 --- a/fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricParticleTypes.java +++ b/fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricParticleTypes.java @@ -37,8 +37,8 @@ import net.minecraft.network.codec.StreamCodec; * * {@literal @}Override * public void onInitialize() { - * Registry.register(Registries.PARTICLE_TYPE, Identifier.of("testmod", "simple"), SIMPLE_TEST_PARTICLE); - * Registry.register(Registries.PARTICLE_TYPE, Identifier.of("testmod", "custom"), CUSTOM_TEST_PARTICLE); + * Registry.register(Registries.PARTICLE_TYPE, Identifier.fromNamespaceAndPath("modid", "simple"), SIMPLE_TEST_PARTICLE); + * Registry.register(Registries.PARTICLE_TYPE, Identifier.fromNamespaceAndPath("modid", "custom"), CUSTOM_TEST_PARTICLE); * }} *
* diff --git a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/DynamicRegistries.java b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/DynamicRegistries.java index a53796e920..83047970d4 100644 --- a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/DynamicRegistries.java +++ b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/DynamicRegistries.java @@ -58,7 +58,7 @@ import net.fabricmc.fabric.impl.registry.sync.DynamicRegistriesImpl; * // @link region substring=RegistryKey target=RegistryKey * // @link region substring=ofRegistry target="RegistryKey#ofRegistry" * // @link region substring=Identifier target="net.minecraft.util.Identifier#Identifier(String, String)" - * public static final RegistryKey> MY_DATA_KEY = RegistryKey.ofRegistry(Identifier.of("my_mod", "my_data")); + * public static final RegistryKey> MY_DATA_KEY = RegistryKey.ofRegistry(Identifier.fromNamespaceAndPath("modid", "my_data")); * // @end @end @end * * // Option 1: Register a non-synced registry diff --git a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/FabricRegistryBuilder.java b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/FabricRegistryBuilder.java index 2eed5cefc1..d4b916fc4a 100644 --- a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/FabricRegistryBuilder.java +++ b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/api/event/registry/FabricRegistryBuilder.java @@ -38,7 +38,7 @@ import net.fabricmc.fabric.mixin.registry.sync.BuiltInRegistriesAccessor; * *
  * {@code
- *  RegistryKey> registryKey = RegistryKey.ofRegistry(Identifier.of("modid", "registry_name"));
+ *  RegistryKey> registryKey = RegistryKey.ofRegistry(Identifier.fromNamespaceAndPath("modid", "custom_registry"));
  *  Registry registry = FabricRegistryBuilder.createSimple(registryKey)
  * 													.attribute(RegistryAttribute.SYNCED)
  * 													.buildAndRegister();
diff --git a/fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/LivingEntityFeatureRendererRegistrationCallback.java b/fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/LivingEntityFeatureRendererRegistrationCallback.java
index e041d25cd0..23c36798f4 100644
--- a/fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/LivingEntityFeatureRendererRegistrationCallback.java
+++ b/fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/LivingEntityFeatureRendererRegistrationCallback.java
@@ -41,8 +41,8 @@ import net.fabricmc.fabric.api.event.EventFactory;
  * 

For example, to register a feature renderer for a player model, the example below may be used: *

  * LivingEntityFeatureRendererRegistrationCallback.EVENT.register((entityType, entityRenderer, registrationHelper) -> {
- * 	if (entityRenderer instanceof PlayerEntityModel) {
- * 		registrationHelper.register(new MyFeatureRenderer((PlayerEntityModel) entityRenderer));
+ * 	if (entityRenderer instanceof AvatarRenderer<?> avatarEntityRenderer) {
+ * 		registrationHelper.register(new MyFeatureRenderer(avatarEntityRenderer, context.getModelSet()));
  * 	}
  * });
  * 
diff --git a/fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/ExtendedScreenHandlerType.java b/fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/ExtendedScreenHandlerType.java index 7f6da44490..34e5be14c6 100644 --- a/fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/ExtendedScreenHandlerType.java +++ b/fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/ExtendedScreenHandlerType.java @@ -50,12 +50,12 @@ import net.minecraft.world.inventory.MenuType; * // Creating and registering the type * public static final ExtendedScreenHandlerType OVEN = * new ExtendedScreenHandlerType((syncId, inventory, data) -> ..., OvenData.PACKET_CODEC); - * Registry.register(Registry.SCREEN_HANDLER, Identifier.of(...), OVEN); + * Registry.register(Registry.MENU, Identifier.fromNamespaceAndPath("modid", "custom_menu"), OVEN); * - * // Note: remember to also register the screen using vanilla's HandledScreens! + * // Note: remember to also register the screen using vanilla's MenuScreens! * * // Screen handler class - * public class OvenScreenHandler extends ScreenHandler { + * public class OvenScreenHandler extends AbstractContainerMenu { * public OvenScreenHandler(int syncId) { * super(MyScreenHandlers.OVEN, syncId); * } diff --git a/fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java b/fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java index ac56dc36c8..b0d9aa0101 100644 --- a/fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java +++ b/fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java @@ -68,7 +68,7 @@ public interface FabricSoundInstance { * class CustomSound extends AbstractSoundInstance { * CustomSound() { * // Use the sound defined in sounds.json - * super(Identifier.of("mod_id", "custom_sound"), SoundCategory.BLOCKS, SoundInstance.createRandom()); + * super(Identifier.fromNamespaceAndPath("modid", "custom_sound"), SoundCategory.BLOCKS, SoundInstance.createRandom()); * } * * @Override