Update comments in autogenerated api data (#2500)

* Regenerate api data * Regenerate api data * Regenerate api data * Run spotlessApply
SpongePowered · May 4, 2024 · d98c06a · d98c06a
1 parent 5b125a1
commit d98c06a
Show file tree

Hide file tree

Showing 65 changed files with 45 additions and 181 deletions.
diff --git a/src/main/java/org/spongepowered/api/advancement/AdvancementTypes.java b/src/main/java/org/spongepowered/api/advancement/AdvancementTypes.java
@@ -34,14 +34,12 @@
 import org.spongepowered.api.registry.RegistryTypes;
 
 /**
- * An enumeration of all the available {@link AdvancementType}s in Minecraft.
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
  */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class AdvancementTypes {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     /**
      * Represents the challenge completion advancement type.
      *
@@ -66,8 +64,6 @@ public final class AdvancementTypes {
      */
     public static final DefaultedRegistryReference<AdvancementType> TASK = AdvancementTypes.key(ResourceKey.sponge("task"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private AdvancementTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/advancement/criteria/trigger/Triggers.java b/src/main/java/org/spongepowered/api/advancement/criteria/trigger/Triggers.java
@@ -40,7 +40,6 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class Triggers {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<Trigger<?>> ALLAY_DROP_ITEM_ON_BLOCK = Triggers.key(ResourceKey.minecraft("allay_drop_item_on_block"));
 
     public static final DefaultedRegistryReference<Trigger<?>> AVOID_VIBRATION = Triggers.key(ResourceKey.minecraft("avoid_vibration"));
@@ -145,7 +144,6 @@ public final class Triggers {
 
     public static final DefaultedRegistryReference<Trigger<?>> VOLUNTARY_EXILE = Triggers.key(ResourceKey.minecraft("voluntary_exile"));
 
-    //@formatter:on
     private Triggers() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/block/BlockTypes.java b/src/main/java/org/spongepowered/api/block/BlockTypes.java
@@ -40,7 +40,6 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class BlockTypes {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<BlockType> ACACIA_BUTTON = BlockTypes.key(ResourceKey.minecraft("acacia_button"));
 
     public static final DefaultedRegistryReference<BlockType> ACACIA_DOOR = BlockTypes.key(ResourceKey.minecraft("acacia_door"));
@@ -2157,7 +2156,6 @@ public final class BlockTypes {
 
     public static final DefaultedRegistryReference<BlockType> ZOMBIE_WALL_HEAD = BlockTypes.key(ResourceKey.minecraft("zombie_wall_head"));
 
-    //@formatter:on
     private BlockTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/block/entity/BlockEntityTypes.java b/src/main/java/org/spongepowered/api/block/entity/BlockEntityTypes.java
@@ -40,7 +40,6 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class BlockEntityTypes {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<BlockEntityType> BANNER = BlockEntityTypes.key(ResourceKey.minecraft("banner"));
 
     public static final DefaultedRegistryReference<BlockEntityType> BARREL = BlockEntityTypes.key(ResourceKey.minecraft("barrel"));
@@ -127,7 +126,6 @@ public final class BlockEntityTypes {
 
     public static final DefaultedRegistryReference<BlockEntityType> TRIAL_SPAWNER = BlockEntityTypes.key(ResourceKey.minecraft("trial_spawner"));
 
-    //@formatter:on
     private BlockEntityTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/ArmorMaterials.java b/src/main/java/org/spongepowered/api/data/type/ArmorMaterials.java
@@ -33,12 +33,13 @@
 import org.spongepowered.api.registry.RegistryScopes;
 import org.spongepowered.api.registry.RegistryTypes;
 
+/**
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
+ */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class ArmorMaterials {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     public static final DefaultedRegistryReference<ArmorMaterial> CHAINMAIL = ArmorMaterials.key(ResourceKey.sponge("chainmail"));
 
     public static final DefaultedRegistryReference<ArmorMaterial> DIAMOND = ArmorMaterials.key(ResourceKey.sponge("diamond"));
@@ -53,8 +54,6 @@ public final class ArmorMaterials {
 
     public static final DefaultedRegistryReference<ArmorMaterial> TURTLE = ArmorMaterials.key(ResourceKey.sponge("turtle"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private ArmorMaterials() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/ArtTypes.java b/src/main/java/org/spongepowered/api/data/type/ArtTypes.java
@@ -40,7 +40,6 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class ArtTypes {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<ArtType> ALBAN = ArtTypes.key(ResourceKey.minecraft("alban"));
 
     public static final DefaultedRegistryReference<ArtType> AZTEC = ArtTypes.key(ResourceKey.minecraft("aztec"));
@@ -101,7 +100,6 @@ public final class ArtTypes {
 
     public static final DefaultedRegistryReference<ArtType> WITHER = ArtTypes.key(ResourceKey.minecraft("wither"));
 
-    //@formatter:on
     private ArtTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/BambooLeavesTypes.java b/src/main/java/org/spongepowered/api/data/type/BambooLeavesTypes.java
@@ -33,18 +33,19 @@
 import org.spongepowered.api.registry.RegistryScopes;
 import org.spongepowered.api.registry.RegistryTypes;
 
+/**
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
+ */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class BambooLeavesTypes {
 
-    // @formatter:off
     public static final DefaultedRegistryReference<BambooLeavesType> LARGE = BambooLeavesTypes.key(ResourceKey.sponge("large"));
 
     public static final DefaultedRegistryReference<BambooLeavesType> NONE = BambooLeavesTypes.key(ResourceKey.sponge("none"));
 
     public static final DefaultedRegistryReference<BambooLeavesType> SMALL = BambooLeavesTypes.key(ResourceKey.sponge("small"));
 
-    // @formatter:on
     private BambooLeavesTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/BannerPatternShapes.java b/src/main/java/org/spongepowered/api/data/type/BannerPatternShapes.java
@@ -40,7 +40,6 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class BannerPatternShapes {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<BannerPatternShape> BASE = BannerPatternShapes.key(ResourceKey.minecraft("base"));
 
     public static final DefaultedRegistryReference<BannerPatternShape> BORDER = BannerPatternShapes.key(ResourceKey.minecraft("border"));
@@ -123,7 +122,6 @@ public final class BannerPatternShapes {
 
     public static final DefaultedRegistryReference<BannerPatternShape> TRIANGLES_TOP = BannerPatternShapes.key(ResourceKey.minecraft("triangles_top"));
 
-    //@formatter:on
     private BannerPatternShapes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/BoatTypes.java b/src/main/java/org/spongepowered/api/data/type/BoatTypes.java
@@ -34,14 +34,12 @@
 import org.spongepowered.api.registry.RegistryTypes;
 
 /**
- * An enumeration of vanilla {@link BoatType}s.
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
  */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class BoatTypes {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     public static final DefaultedRegistryReference<BoatType> ACACIA = BoatTypes.key(ResourceKey.sponge("acacia"));
 
     public static final DefaultedRegistryReference<BoatType> BAMBOO = BoatTypes.key(ResourceKey.sponge("bamboo"));
@@ -60,8 +58,6 @@ public final class BoatTypes {
 
     public static final DefaultedRegistryReference<BoatType> SPRUCE = BoatTypes.key(ResourceKey.sponge("spruce"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private BoatTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/CatTypes.java b/src/main/java/org/spongepowered/api/data/type/CatTypes.java
@@ -40,7 +40,6 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class CatTypes {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<CatType> ALL_BLACK = CatTypes.key(ResourceKey.minecraft("all_black"));
 
     public static final DefaultedRegistryReference<CatType> BLACK = CatTypes.key(ResourceKey.minecraft("black"));
@@ -63,7 +62,6 @@ public final class CatTypes {
 
     public static final DefaultedRegistryReference<CatType> WHITE = CatTypes.key(ResourceKey.minecraft("white"));
 
-    //@formatter:on
     private CatTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/DyeColors.java b/src/main/java/org/spongepowered/api/data/type/DyeColors.java
@@ -34,14 +34,12 @@
 import org.spongepowered.api.registry.RegistryTypes;
 
 /**
- * An enumeration of vanilla {@link DyeColor}s.
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
  */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class DyeColors {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     public static final DefaultedRegistryReference<DyeColor> BLACK = DyeColors.key(ResourceKey.sponge("black"));
 
     public static final DefaultedRegistryReference<DyeColor> BLUE = DyeColors.key(ResourceKey.sponge("blue"));
@@ -74,8 +72,6 @@ public final class DyeColors {
 
     public static final DefaultedRegistryReference<DyeColor> YELLOW = DyeColors.key(ResourceKey.sponge("yellow"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private DyeColors() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/FoxTypes.java b/src/main/java/org/spongepowered/api/data/type/FoxTypes.java
@@ -34,20 +34,16 @@
 import org.spongepowered.api.registry.RegistryTypes;
 
 /**
- * An enumeration of vanilla {@link FoxType}s.
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
  */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class FoxTypes {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     public static final DefaultedRegistryReference<FoxType> RED = FoxTypes.key(ResourceKey.sponge("red"));
 
     public static final DefaultedRegistryReference<FoxType> SNOW = FoxTypes.key(ResourceKey.sponge("snow"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private FoxTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/FrogTypes.java b/src/main/java/org/spongepowered/api/data/type/FrogTypes.java
@@ -40,14 +40,12 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class FrogTypes {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<FrogType> COLD = FrogTypes.key(ResourceKey.minecraft("cold"));
 
     public static final DefaultedRegistryReference<FrogType> TEMPERATE = FrogTypes.key(ResourceKey.minecraft("temperate"));
 
     public static final DefaultedRegistryReference<FrogType> WARM = FrogTypes.key(ResourceKey.minecraft("warm"));
 
-    //@formatter:on
     private FrogTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/HorseColors.java b/src/main/java/org/spongepowered/api/data/type/HorseColors.java
@@ -34,14 +34,12 @@
 import org.spongepowered.api.registry.RegistryTypes;
 
 /**
- * An enumeration of vanilla {@link HorseColor}s.
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
  */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class HorseColors {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     public static final DefaultedRegistryReference<HorseColor> BLACK = HorseColors.key(ResourceKey.sponge("black"));
 
     public static final DefaultedRegistryReference<HorseColor> BROWN = HorseColors.key(ResourceKey.sponge("brown"));
@@ -56,8 +54,6 @@ public final class HorseColors {
 
     public static final DefaultedRegistryReference<HorseColor> WHITE = HorseColors.key(ResourceKey.sponge("white"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private HorseColors() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/HorseStyles.java b/src/main/java/org/spongepowered/api/data/type/HorseStyles.java
@@ -34,14 +34,12 @@
 import org.spongepowered.api.registry.RegistryTypes;
 
 /**
- * An enumeration of vanilla {@link HorseStyle}s.
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
  */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class HorseStyles {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     public static final DefaultedRegistryReference<HorseStyle> BLACK_DOTS = HorseStyles.key(ResourceKey.sponge("black_dots"));
 
     public static final DefaultedRegistryReference<HorseStyle> NONE = HorseStyles.key(ResourceKey.sponge("none"));
@@ -52,8 +50,6 @@ public final class HorseStyles {
 
     public static final DefaultedRegistryReference<HorseStyle> WHITE_FIELD = HorseStyles.key(ResourceKey.sponge("white_field"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private HorseStyles() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/InstrumentTypes.java b/src/main/java/org/spongepowered/api/data/type/InstrumentTypes.java
@@ -34,14 +34,12 @@
 import org.spongepowered.api.registry.RegistryTypes;
 
 /**
- * An enumeration of vanilla {@link InstrumentType}s.
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
  */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class InstrumentTypes {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     public static final DefaultedRegistryReference<InstrumentType> BANJO = InstrumentTypes.key(ResourceKey.sponge("banjo"));
 
     public static final DefaultedRegistryReference<InstrumentType> BASE_DRUM = InstrumentTypes.key(ResourceKey.sponge("basedrum"));
@@ -88,8 +86,6 @@ public final class InstrumentTypes {
 
     public static final DefaultedRegistryReference<InstrumentType> ZOMBIE = InstrumentTypes.key(ResourceKey.sponge("zombie"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private InstrumentTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/ProfessionTypes.java b/src/main/java/org/spongepowered/api/data/type/ProfessionTypes.java
@@ -40,7 +40,6 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class ProfessionTypes {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<ProfessionType> ARMORER = ProfessionTypes.key(ResourceKey.minecraft("armorer"));
 
     public static final DefaultedRegistryReference<ProfessionType> BUTCHER = ProfessionTypes.key(ResourceKey.minecraft("butcher"));
@@ -71,7 +70,6 @@ public final class ProfessionTypes {
 
     public static final DefaultedRegistryReference<ProfessionType> WEAPONSMITH = ProfessionTypes.key(ResourceKey.minecraft("weaponsmith"));
 
-    //@formatter:on
     private ProfessionTypes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/TropicalFishShapes.java b/src/main/java/org/spongepowered/api/data/type/TropicalFishShapes.java
@@ -26,7 +26,6 @@
 
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.Sponge;
-import org.spongepowered.api.entity.living.aquatic.fish.school.TropicalFish;
 import org.spongepowered.api.registry.DefaultedRegistryReference;
 import org.spongepowered.api.registry.Registry;
 import org.spongepowered.api.registry.RegistryKey;
@@ -35,14 +34,12 @@
 import org.spongepowered.api.registry.RegistryTypes;
 
 /**
- * An enumeration of vanilla shapes for {@link TropicalFish}.
+ * <!-- This file is automatically generated. Any manual changes will be overwritten. -->
  */
 @SuppressWarnings("unused")
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class TropicalFishShapes {
 
-    // @formatter:off
-    // SORTFIELDS:ON
     public static final DefaultedRegistryReference<TropicalFishShape> BETTY = TropicalFishShapes.key(ResourceKey.sponge("betty"));
 
     public static final DefaultedRegistryReference<TropicalFishShape> BLOCKFISH = TropicalFishShapes.key(ResourceKey.sponge("blockfish"));
@@ -67,8 +64,6 @@ public final class TropicalFishShapes {
 
     public static final DefaultedRegistryReference<TropicalFishShape> SUNSTREAK = TropicalFishShapes.key(ResourceKey.sponge("sunstreak"));
 
-    // SORTFIELDS:OFF
-    // @formatter:on
     private TropicalFishShapes() {
     }
 

diff --git a/src/main/java/org/spongepowered/api/data/type/VillagerTypes.java b/src/main/java/org/spongepowered/api/data/type/VillagerTypes.java
@@ -40,7 +40,6 @@
 @RegistryScopes(scopes = RegistryScope.GAME)
 public final class VillagerTypes {
 
-    //@formatter:off
     public static final DefaultedRegistryReference<VillagerType> DESERT = VillagerTypes.key(ResourceKey.minecraft("desert"));
 
     public static final DefaultedRegistryReference<VillagerType> JUNGLE = VillagerTypes.key(ResourceKey.minecraft("jungle"));
@@ -55,7 +54,6 @@ public final class VillagerTypes {
 
     public static final DefaultedRegistryReference<VillagerType> TAIGA = VillagerTypes.key(ResourceKey.minecraft("taiga"));
 
-    //@formatter:on
     private VillagerTypes() {
     }