Merge pull request #24 from CodeMonkeysMods/coderabbitai/docstrings/8bd20de

📝 Add docstrings to `Logs`

Author: AnyaPizza

src/client/java/com/tcm/MineTale/MineTaleDataGen.java

@@ -7,11 +7,19 @@
 
 public class MineTaleDataGen implements DataGeneratorEntrypoint {
 
+    /**
+     * Initialize a data pack and register the mod's data providers.
+     *
+     * Creates a data pack from the given Fabric data generator and adds the language
+     * and model providers so they will run during data generation.
+     *
+     * @param fabricDataGenerator the Fabric data generator used to create the data pack
+     */
     @Override
     public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
         FabricDataGenerator.Pack pack = fabricDataGenerator.createPack();
 
         pack.addProvider(ModLangProvider::new);
         pack.addProvider(ModModelProvider::new);
     }
-}
+}

src/client/java/com/tcm/MineTale/datagen/ModLangProvider.java

@@ -7,10 +7,21 @@
 import java.util.concurrent.CompletableFuture;
 
 public class ModLangProvider extends FabricLanguageProvider {
+    /**
+     * Creates a ModLangProvider configured to generate the mod's language translations.
+     *
+     * @param dataOutput     the FabricDataOutput used to write generated language files
+     * @param registryLookup a CompletableFuture supplying a HolderLookup.Provider for registry lookups during data generation
+     */
     public ModLangProvider(FabricDataOutput dataOutput, CompletableFuture<HolderLookup.Provider> registryLookup) {
         super(dataOutput, registryLookup);
     }
 
+    /**
+     * Populates the translation builder with English language entries for MineTale (creative tab title and block names).
+     *
+     * @param translationBuilder the builder used to register translation keys and their English values
+     */
     @Override
     public void generateTranslations(HolderLookup.Provider wrapperLookup, TranslationBuilder translationBuilder) {
         translationBuilder.add("minetale.creative_tab.title", "MineTale Stuffs");
@@ -51,4 +62,4 @@ public void generateTranslations(HolderLookup.Provider wrapperLookup, Translatio
         translationBuilder.add("block.minetale.wild_wisteria_log", "Wild Wisteria Log");
         translationBuilder.add("block.minetale.wild_wisteria_wood", "Wild Wisteria Wood");
     }
-}
+}

src/client/java/com/tcm/MineTale/datagen/ModModelProvider.java

@@ -7,8 +7,21 @@
 import net.minecraft.client.data.models.ItemModelGenerators;
 
 public class ModModelProvider extends FabricModelProvider {
-    public ModModelProvider(FabricDataOutput output) { super(output); }
+    /**
+ * Creates a ModModelProvider using the given Fabric data output.
+ *
+ * @param output the FabricDataOutput used to write generated model and blockstate data
+ */
+public ModModelProvider(FabricDataOutput output) { super(output); }
 
+    /**
+     * Registers block state and model definitions for the mod's log blocks.
+     *
+     * This configures horizontal and vertical log models for each custom log block and, for
+     * WILD_WISTERIA_LOG, also registers the corresponding wood model (WILD_WISTERIA_WOOD).
+     *
+     * @param blockStateModelGenerator the generator used to create block state and model entries
+     */
     @Override
     public void generateBlockStateModels(BlockModelGenerators blockStateModelGenerator) {
         blockStateModelGenerator.woodProvider(ModBlocks.AMBER_LOG).logWithHorizontal(ModBlocks.AMBER_LOG);
@@ -43,8 +56,13 @@ public void generateBlockStateModels(BlockModelGenerators blockStateModelGenerat
         blockStateModelGenerator.woodProvider(ModBlocks.WILD_WISTERIA_LOG).logWithHorizontal(ModBlocks.WILD_WISTERIA_LOG).wood(ModBlocks.WILD_WISTERIA_WOOD);
     }
 
+    /**
+     * Registers item models for the mod; currently left empty (no item models are generated).
+     *
+     * @param itemModelGenerators generator used to register item models
+     */
     @Override
     public void generateItemModels(ItemModelGenerators itemModelGenerators) {
 
     }
-}
+}

src/main/java/com/tcm/MineTale/datagen/ModBlockTagProvider.java

@@ -9,10 +9,23 @@
 import java.util.concurrent.CompletableFuture;
 
 public class ModBlockTagProvider extends FabricTagProvider.BlockTagProvider {
+    /**
+     * Creates a ModBlockTagProvider used to generate block tag data for the mod (e.g., assigning mod log blocks to BlockTags.LOGS).
+     *
+     * @param output the Fabric data output target used to write generated data
+     * @param registriesFuture a future that supplies registry lookups required during data generation
+     */
     public ModBlockTagProvider(FabricDataOutput output, CompletableFuture<HolderLookup.Provider> registriesFuture) {
         super(output, registriesFuture);
     }
 
+    /**
+     * Populates the BlockTags.LOGS tag with this mod's log blocks.
+     *
+     * Registers each mod-defined log block so they are included in the game's LOGS tag mapping.
+     *
+     * @param provider a registry lookup provider used to resolve holders during tag population
+     */
     @Override
     protected void addTags(HolderLookup.Provider provider) {
         valueLookupBuilder(BlockTags.LOGS)
@@ -47,4 +60,4 @@ protected void addTags(HolderLookup.Provider provider) {
                 .add(ModBlocks.WINDWILLOW_LOG)
                 .add(ModBlocks.WILD_WISTERIA_LOG);
     }
-}
+}

src/main/java/com/tcm/MineTale/datagen/ModDataGenerator.java

@@ -6,12 +6,11 @@
 public class ModDataGenerator implements DataGeneratorEntrypoint {
 
     /**
-     * Initializes data generation by creating a new data pack and registering recipe providers.
+     * Sets up data generation by creating a data pack and registering providers for recipes and block tags.
      *
-     * Creates a FabricDataGenerator.Pack from the provided generator and registers
-     * ModRecipeProvider as a provider for that pack.
+     * Registers ModRecipeProvider and ModBlockTagProvider with the created pack.
      *
-     * @param fabricDataGenerator the FabricDataGenerator used to create packs and register providers
+     * @param fabricDataGenerator the FabricDataGenerator used to create data packs and register providers
      */
     @Override
 	public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {