comments

GTNewHorizons · Jan 7, 2025 · d50180f · d50180f
1 parent 330cbdc
commit d50180f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/src/main/java/com/gtnewhorizon/gtnhlib/util/data/BlockMeta.java b/src/main/java/com/gtnewhorizon/gtnhlib/util/data/BlockMeta.java
@@ -5,9 +5,10 @@
 import net.minecraft.block.Block;
 
 /**
- * A mutable implementation of {@link ImmutableBlockMeta}. Must follow the same contracts as the immutable version. If
- * your API should return a mutable pair, return this instead. If this type is exposed instead of the immutable
- * interface, assume that the contained values can change.
+ * A mutable implementation of {@link ImmutableBlockMeta}. If your API should return a mutable pair, return this
+ * instead. Must follow the same contracts as the immutable version if this is ever upcast to a
+ * {@link ImmutableBlockMeta} in your API. If this type is exposed instead of the immutable interface, assume that the
+ * contained values can change.
  */
 public class BlockMeta implements ImmutableBlockMeta {
 

diff --git a/src/main/java/com/gtnewhorizon/gtnhlib/util/data/ItemMeta.java b/src/main/java/com/gtnewhorizon/gtnhlib/util/data/ItemMeta.java
@@ -5,9 +5,9 @@
 import net.minecraft.item.Item;
 
 /**
- * A mutable implementation of {@link ImmutableItemMeta}. Must follow the same contracts as the immutable version. If
- * your API should return a mutable pair, return this instead. If this type is exposed instead of the immutable
- * interface, assume that the contained values can change.
+ * A mutable implementation of {@link ImmutableItemMeta}. If your API should return a mutable pair, return this instead.
+ * Must follow the same contracts as the immutable version if this is ever upcast to a {@link ImmutableItemMeta} in your
+ * API. If this type is exposed instead of the immutable interface, assume that the contained values can change.
  */
 public class ItemMeta implements ImmutableItemMeta {
 

diff --git a/src/main/java/com/gtnewhorizon/gtnhlib/util/data/LazyBlock.java b/src/main/java/com/gtnewhorizon/gtnhlib/util/data/LazyBlock.java
@@ -14,7 +14,7 @@
  * {@code
  * private static final LazyBlock SOME_OPTIONAL_BLOCK = new LazyBlock(Mods.SomeMod, "foo");
  * 
- * {@literal @}Optional.Method(Names.SOME_MOD)
+ * {@literal @}Optional.Method(modid = Names.SOME_MOD)
  * public static void doSomething(World world, int x, int y, int z) {
  *   if (world.getBlock(x, y, z) == SOME_OPTIONAL_BLOCK.getBlock()) {
  *      ...

diff --git a/src/main/java/com/gtnewhorizon/gtnhlib/util/data/LazyItem.java b/src/main/java/com/gtnewhorizon/gtnhlib/util/data/LazyItem.java
@@ -17,7 +17,7 @@
  * {@code
  * private static final LazyItem SOME_OPTIONAL_ITEM = new LazyItem(Mods.SomeMod, "foo");
  * 
- * {@literal @}Optional.Method(Names.SOME_MOD)
+ * {@literal @}Optional.Method(modid = Names.SOME_MOD)
  * public static void doSomething(ItemStack stack) {
  *   if (SOME_OPTIONAL_BLOCK.matches(stack)) {
  *      ...