More Javadoc.

Crystal-Nest · Jun 16, 2024 · 86e4ae2 · 86e4ae2
1 parent 4f2cf59
commit 86e4ae2
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 5 deletions.
diff --git a/common/src/main/java/it/crystalnest/soul_fire_d/api/Fire.java b/common/src/main/java/it/crystalnest/soul_fire_d/api/Fire.java
@@ -164,6 +164,7 @@ public boolean canRainDouse() {
   /**
    * Returns the In Fire {@link DamageSource} from the given {@link Entity}.
    *
+   * @param entity entity.
    * @return the In Fire {@link DamageSource} from the given {@link Entity}.
    */
   public DamageSource getInFire(Entity entity) {
@@ -173,6 +174,7 @@ public DamageSource getInFire(Entity entity) {
   /**
    * Returns the On Fire {@link DamageSource} from the given {@link Entity}.
    *
+   * @param entity entity.
    * @return the On Fire {@link DamageSource} from the given {@link Entity}.
    */
   public DamageSource getOnFire(Entity entity) {
@@ -575,6 +577,7 @@ public Builder setCanRainDouse(boolean canRainDouse) {
     /**
      * Sets the {@link DamageSource} {@link #inFireGetter}.
      *
+     * @param getter damage source getter.
      * @return this Builder to either set other properties or {@link #register}.
      */
     public Builder setInFire(Function<Entity, DamageSource> getter) {
@@ -585,6 +588,7 @@ public Builder setInFire(Function<Entity, DamageSource> getter) {
     /**
      * Sets the {@link DamageSource} {@link #inFireGetter}.
      *
+     * @param getter damage source getter.
      * @return this Builder to either set other properties or {@link #register}.
      */
     public Builder setOnFire(Function<Entity, DamageSource> getter) {

diff --git a/common/src/main/java/it/crystalnest/soul_fire_d/api/enchantment/FireEnchantmentBuilder.java b/common/src/main/java/it/crystalnest/soul_fire_d/api/enchantment/FireEnchantmentBuilder.java
@@ -270,6 +270,8 @@ public final <B extends FireEnchantmentBuilder<T>> B setDuration(int duration) {
 
   /**
    * Builds and registers the enchantment instance.
+   *
+   * @return enchantment ID.
    */
   public ResourceLocation register() {
     ResourceLocation key = new ResourceLocation(fireType.getNamespace(), fireType.getPath() + "_" + kind);

diff --git a/forge/src/main/java/it/crystalnest/soul_fire_d/handler/FMLClientSetupEventHandler.java b/forge/src/main/java/it/crystalnest/soul_fire_d/handler/FMLClientSetupEventHandler.java
@@ -27,8 +27,7 @@ public final class FMLClientSetupEventHandler {
   private FMLClientSetupEventHandler() {}
 
   /**
-   * Handles the {@link FMLClientSetupEvent} event.<br />
-   * Registers all {@link Fire Fires} to the client.
+   * Handles the {@link FMLClientSetupEvent} event.
    *
    * @param event {@link FMLClientSetupEvent}.
    */
@@ -42,11 +41,21 @@ public static void handle(FMLClientSetupEvent event) {
     FireManager.getComponentList(Fire.Component.WALL_TORCH_BLOCK).stream().filter(CustomWallTorchBlock.class::isInstance).forEach(torch -> ItemBlockRenderTypes.setRenderLayer(torch, RenderType.cutout()));
   }
 
+  /**
+   * Handles the {@link RegisterParticleProvidersEvent} event.
+   *
+   * @param event {@link RegisterParticleProvidersEvent}.
+   */
   @SubscribeEvent
   public static void registerParticleProviders(RegisterParticleProvidersEvent event) {
     FireManager.getComponentList(Fire.Component.FLAME_PARTICLE).forEach(flame -> event.registerSpriteSet(flame, FlameParticle.Provider::new));
   }
 
+  /**
+   * Handles the {@link EntityRenderersEvent.RegisterRenderers} event.
+   *
+   * @param event {@link EntityRenderersEvent.RegisterRenderers}.
+   */
   @SubscribeEvent
   public static void registerRenderers(EntityRenderersEvent.RegisterRenderers event) {
     event.registerBlockEntityRenderer(FireManager.CUSTOM_CAMPFIRE_ENTITY_TYPE.get(), CampfireRenderer::new);

diff --git a/neoforge/src/main/java/it/crystalnest/soul_fire_d/handler/FMLClientSetupEventHandler.java b/neoforge/src/main/java/it/crystalnest/soul_fire_d/handler/FMLClientSetupEventHandler.java
@@ -12,7 +12,6 @@
 import net.minecraft.client.renderer.ItemBlockRenderTypes;
 import net.minecraft.client.renderer.RenderType;
 import net.minecraft.client.renderer.blockentity.CampfireRenderer;
-import net.minecraft.core.particles.SimpleParticleType;
 import net.neoforged.api.distmarker.Dist;
 import net.neoforged.bus.api.SubscribeEvent;
 import net.neoforged.fml.common.Mod;
@@ -28,8 +27,7 @@ public final class FMLClientSetupEventHandler {
   private FMLClientSetupEventHandler() {}
 
   /**
-   * Handles the {@link FMLClientSetupEvent} event.<br />
-   * Registers all {@link Fire Fires} to the client.
+   * Handles the {@link FMLClientSetupEvent} event.
    *
    * @param event {@link FMLClientSetupEvent}.
    */
@@ -43,11 +41,21 @@ public static void handle(FMLClientSetupEvent event) {
     FireManager.getComponentList(Fire.Component.WALL_TORCH_BLOCK).stream().filter(CustomWallTorchBlock.class::isInstance).forEach(torch -> ItemBlockRenderTypes.setRenderLayer(torch, RenderType.cutout()));
   }
 
+  /**
+   * Handles the {@link RegisterParticleProvidersEvent} event.
+   *
+   * @param event {@link RegisterParticleProvidersEvent}.
+   */
   @SubscribeEvent
   public static void registerParticleProviders(RegisterParticleProvidersEvent event) {
     FireManager.getComponentList(Fire.Component.FLAME_PARTICLE).forEach(flame -> event.registerSpriteSet(flame, FlameParticle.Provider::new));
   }
 
+  /**
+   * Handles the {@link EntityRenderersEvent.RegisterRenderers} event.
+   *
+   * @param event {@link EntityRenderersEvent.RegisterRenderers}.
+   */
   @SubscribeEvent
   public static void registerRenderers(EntityRenderersEvent.RegisterRenderers event) {
     event.registerBlockEntityRenderer(FireManager.CUSTOM_CAMPFIRE_ENTITY_TYPE.get(), CampfireRenderer::new);