📝 Add docstrings to feat/add-farmers-workbench

Docstrings generation was requested by @The-Code-Monkey.

The following files were modified:

* `src/client/java/com/tcm/MineTale/MineTaleClient.java`
* `src/client/java/com/tcm/MineTale/block/workbenches/screen/ArmorersWorkbenchScreen.java`
* `src/client/java/com/tcm/MineTale/block/workbenches/screen/FarmersWorkbenchScreen.java`
* `src/client/java/com/tcm/MineTale/block/workbenches/screen/WorkbenchWorkbenchScreen.java`
* `src/client/java/com/tcm/MineTale/datagen/recipes/FarmerRecipes.java`
* `src/client/java/com/tcm/MineTale/datagen/recipes/WorkbenchRecipes.java`
* `src/main/java/com/tcm/MineTale/MineTale.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/FarmersWorkbench.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/entity/FarmersWorkbenchEntity.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/menu/AbstractWorkbenchContainerMenu.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/menu/ArmorersWorkbenchMenu.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/menu/CampfireWorkbenchMenu.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/menu/FarmersWorkbenchMenu.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/menu/FurnaceWorkbenchMenu.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/menu/WorkbenchWorkbenchMenu.java`
* `src/main/java/com/tcm/MineTale/registry/ModRecipes.java`

Author: coderabbitai[bot]

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

@@ -24,12 +24,15 @@
 
 public class MineTaleClient implements ClientModInitializer {
 	/**
-	 * Register client-side screen factories for custom workbench menu types.
+	 * Initializes client-side handlers for the MineTale mod.
 	 *
-	 * Binds ModMenuTypes.FURNACE_WORKBENCH_MENU to FurnaceWorkbenchScreen,
-	 * ModMenuTypes.CAMPFIRE_WORKBENCH_MENU to CampfireWorkbenchScreen, and
-	 * ModMenuTypes.WORKBENCH_WORKBENCH_MENU to WorkbenchWorkbenchScreen so the client
-	 * can create the appropriate GUI when those menus open.
+	 * Registers screen factories for custom workbench menu types, configures block render
+	 * layers for furnace workbenches, and registers a global network receiver that applies
+	 * nearby inventory item lists to an open workbench menu when available.
+	 *
+	 * The network receiver schedules a client task that retries up to 10 frames if the
+	 * player's container menu is not yet an instance of the expected workbench menu and
+	 * logs a failure message if synchronization could not be applied after retries.
 	 */
 	@Override
 	public void onInitializeClient() {

src/client/java/com/tcm/MineTale/block/workbenches/screen/ArmorersWorkbenchScreen.java

@@ -118,6 +118,15 @@ protected void init() {
         }).bounds(defaultLeft + 40, defaultTop + 22, 35, 20).build());
     }
 
+    /**
+     * Sends a craft request for the recipe remembered by this screen's last known selection.
+     *
+     * Resolves the remembered recipe to its resulting item(s) and, if available, sends a network
+     * CraftRequestPayload containing the first result and the requested amount. If no remembered
+     * selection or no results are available, no payload is sent.
+     *
+     * @param amount the quantity to craft; use -1 to request crafting all available units
+     */
     private void handleCraftRequest(int amount) {
         // Look at our "Memory" instead of the component
         if (this.lastKnownSelectedId != null) {

src/client/java/com/tcm/MineTale/block/workbenches/screen/FarmersWorkbenchScreen.java

@@ -50,7 +50,7 @@ public class FarmersWorkbenchScreen extends AbstractRecipeBookScreen<FarmersWork
     private Button craftAllBtn;
 
     /**
-     * Initialize a workbench GUI screen using the provided container menu, player inventory, and title.
+     * Creates a FarmersWorkbenchScreen configured with the provided container menu, player inventory, and title.
      *
      * @param menu      the menu supplying slots and synchronized state for this screen
      * @param inventory the player's inventory to display and interact with
@@ -74,10 +74,10 @@ private FarmersWorkbenchScreen(FarmersWorkbenchMenu menu, Inventory inventory, C
     }
 
     /**
-     * Create a MineTaleRecipeBookComponent configured for the workbench screen.
+     * Creates a MineTaleRecipeBookComponent configured for the farmers workbench screen.
      *
      * @param menu the workbench menu used to initialize the recipe book component
-     * @return a MineTaleRecipeBookComponent containing the workbench tab and associated recipe category
+     * @return the recipe book component containing the workbench tab and the FARMERS recipe category
      */
     private static MineTaleRecipeBookComponent createRecipeBookComponent(FarmersWorkbenchMenu menu) {
         ItemStack tabIcon = new ItemStack(ModBlocks.FARMERS_WORKBENCH_BLOCK.asItem());
@@ -90,12 +90,12 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(FarmersWork
     }
 
     /**
-         * Configure the screen's GUI dimensions and initialize widgets.
-         *
-         * Sets the layout size (imageWidth = 176, imageHeight = 166), delegates remaining
-         * layout initialization to the superclass, and creates the three craft buttons
-         * ("1", "10", "All") wired to their respective handlers.
-         */
+     * Configure the screen layout size and initialize crafting widgets.
+     *
+     * Sets the GUI dimensions to 176x166 and creates three craft buttons:
+     * "Craft" (requests 1), "x10" (requests 10), and "All" (requests all, represented by -1),
+     * each wired to their respective handler.
+     */
     @Override
     protected void init() {
         // Important: Set your GUI size before super.init()
@@ -121,14 +121,14 @@ protected void init() {
     }
 
     /**
-     * Sends a crafting request for the currently selected recipe in the integrated recipe book.
-     *
-     * Locates the last recipe collection and last selected recipe ID from the recipe book component,
-     * resolves the recipe's result item, and sends a CraftRequestPayload to the server containing that
-     * item and the requested amount.
-     *
-     * @param amount the quantity to craft; use -1 to request crafting of the full available stack ("All")
-     */
+         * Requests the server to craft the currently selected recipe from the integrated recipe book.
+         *
+         * If a previously selected recipe is remembered and has at least one result item, sends a
+         * CraftRequestPayload containing the recipe's primary result and the requested amount. If no
+         * remembered selection or no result exists, no request is sent.
+         *
+         * @param amount the quantity to craft; use -1 to request crafting the maximum available amount ("All")
+         */
     private void handleCraftRequest(int amount) {
         // Look at our "Memory" instead of the component
         if (this.lastKnownSelectedId != null) {
@@ -161,6 +161,14 @@ protected void renderBg(GuiGraphics guiGraphics, float f, int i, int j) {
       guiGraphics.blit(RenderPipelines.GUI_TEXTURED, TEXTURE, k, l, 0.0F, 0.0F, this.imageWidth, this.imageHeight, 256, 256);
    }
 
+    /**
+     * Renders the screen, preserves the last selected recipe, and updates craft button states.
+     *
+     * Remembers the recipe book's current selection (so selection persists when the book is closed),
+     * resolves the corresponding known RecipeDisplayEntry from the player's recipe book when available,
+     * enables or disables the craft buttons based on whether the player can craft 1, more-than-one, or 10
+     * of the selected recipe, and renders the background and tooltips.
+     */
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {
         renderBackground(graphics, mouseX, mouseY, delta);
@@ -201,11 +209,11 @@ public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {
     }
 
     /**
-     * Determines whether the player has enough ingredients to craft the given recipe the specified number of times.
+     * Checks whether the given player has the required ingredients to craft the specified recipe the provided number of times.
      *
-     * @param player     the player whose inventory (and networked nearby items) will be checked; may be null
-     * @param entry      the recipe display entry providing crafting requirements; may be null
-     * @param craftCount the multiplier for required ingredient quantities (e.g., 1, 10, or -1 is not specially handled here)
+     * @param player     the player whose inventory and nearby networked items are considered; may be null
+     * @param entry      the recipe entry supplying crafting requirements; may be null
+     * @param craftCount the number of times to craft the recipe (multiplies each requirement)
      * @return `true` if the player has at least the required quantity of each ingredient multiplied by `craftCount`, `false` otherwise (also returns `false` if `player` or `entry` is null or the recipe has no requirements)
      */
     private boolean canCraft(Player player, RecipeDisplayEntry entry, int craftCount) {
@@ -248,6 +256,18 @@ private boolean canCraft(Player player, RecipeDisplayEntry entry, int craftCount
         return true;
     }
 
+    /**
+     * Checks whether the given inventory combined with the workbench's networked nearby items
+     * contains at least the requested number of items matching the provided ingredient.
+     *
+     * Counts matching item stacks from the supplied player inventory and, when the screen's menu
+     * is an AbstractWorkbenchContainerMenu, from its networked nearby items list.
+     *
+     * @param inventory     the player's inventory to search
+     * @param ingredient    the ingredient matcher to test item stacks against
+     * @param totalRequired the total number of matching items required
+     * @return `true` if the combined sources contain at least `totalRequired` matching items, `false` otherwise
+     */
     private boolean hasIngredientAmount(Inventory inventory, Ingredient ingredient, int totalRequired) {
         System.out.println("DEBUG: Searching inventory + nearby for " + totalRequired + "...");
         if (totalRequired <= 0) return true;

src/client/java/com/tcm/MineTale/block/workbenches/screen/WorkbenchWorkbenchScreen.java

@@ -121,11 +121,10 @@ protected void init() {
     }
 
     /**
-     * Sends a crafting request for the currently selected recipe in the integrated recipe book.
+     * Request crafting for the currently selected recipe from the integrated recipe book.
      *
-     * Locates the last recipe collection and last selected recipe ID from the recipe book component,
-     * resolves the recipe's result item, and sends a CraftRequestPayload to the server containing that
-     * item and the requested amount.
+     * If a recipe is selected, sends a CraftRequestPayload to the server for that recipe and the
+     * specified quantity. If no recipe is selected, no request is sent.
      *
      * @param amount the quantity to craft; use -1 to request crafting of the full available stack ("All")
      */
@@ -161,6 +160,14 @@ protected void renderBg(GuiGraphics guiGraphics, float f, int i, int j) {
       guiGraphics.blit(RenderPipelines.GUI_TEXTURED, TEXTURE, k, l, 0.0F, 0.0F, this.imageWidth, this.imageHeight, 256, 256);
    }
 
+    /**
+     * Renders the screen, updates the remembered recipe selection, and enables or disables craft buttons based on the player's available ingredients.
+     *
+     * <p>This method draws the background and the superclass UI, captures the current recipe selection (persisting it to
+     * {@code lastKnownSelectedId} when present), resolves the remembered selection against the client's known recipes
+     * (when a level and player are available), updates the activation state of the craft buttons for counts of 1, 2 and 10
+     * depending on whether the player has sufficient materials, and finally renders any tooltips.</p>
+     */
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {
         renderBackground(graphics, mouseX, mouseY, delta);

src/client/java/com/tcm/MineTale/datagen/recipes/FarmerRecipes.java

@@ -13,6 +13,17 @@
 import net.minecraft.world.level.block.Blocks;
 
 public class FarmerRecipes {
+    /**
+     * Registers Farmer workbench recipes and writes them to the provided exporter.
+     *
+     * <p>Emits multiple WorkbenchRecipeBuilder entries (bamboo planter, moss variants, rugs,
+     * vines, soil/grass variants, and other farmer-related recipes) and configures their
+     * ingredient lists, times, book categories, and unlock conditions.</p>
+     *
+     * @param provider source of recipe unlock predicates (used to build "has_farmers_workbench" and similar conditions)
+     * @param exporter destination that receives the generated recipe data
+     * @param lookup   holder/tag resolver used when recipes specify ingredients by tag
+     */
     public static void buildRecipes(RecipeProvider provider, RecipeOutput exporter, HolderLookup.Provider lookup) {
         // new WorkbenchRecipeBuilder(ModRecipes.FARMERS_TYPE, ModRecipes.FARMERS_SERIALIZER)
         //     .input(ItemTags.PLANKS, lookup, 20)

src/client/java/com/tcm/MineTale/datagen/recipes/WorkbenchRecipes.java

@@ -13,6 +13,17 @@
 import net.minecraft.world.item.Items;
 
 public class WorkbenchRecipes {
+    /**
+     * Registers workbench crafting recipes and saves them to the provided exporter.
+     *
+     * Builds and configures multiple WorkbenchRecipeBuilder instances (inputs, outputs, craft time,
+     * unlock conditions, and book category) and persists each recipe using the exporter with a
+     * unique identifier.
+     *
+     * @param provider a RecipeProvider used to query existing items/blocks for unlock conditions and tags
+     * @param exporter the RecipeOutput that receives and writes the generated recipe data
+     * @param lookup   a HolderLookup.Provider used to resolve tag holders (e.g., ItemTags) when specifying inputs
+     */
     public static void buildRecipes(RecipeProvider provider, RecipeOutput exporter, HolderLookup.Provider lookup) {
         new WorkbenchRecipeBuilder(ModRecipes.WORKBENCH_TYPE, ModRecipes.WORKBENCH_SERIALIZER)
             .input(Items.COPPER_INGOT, 2)

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

@@ -42,10 +42,11 @@ public class MineTale implements ModInitializer {
 	public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID);
 
 	/**
-	 * Initializes and registers the mod's game content and subsystems during Fabric startup.
+	 * Initialize and register the mod's game content, network payloads, and runtime subsystems on startup.
 	 *
-	 * <p>Triggers initialization for blocks, block entities, menu types, entities, items, and entity
-	 * data serializers so they are registered with the game before gameplay begins.</p>
+	 * <p>Registers blocks, items, block entities, entities, menus, recipes, recipe displays, creative tab,
+	 * entity data serializers, recipe serializer synchronization, and loot-table modifiers. Also registers
+	 * client↔server payload codecs and a global server receiver that processes craft requests from workbench-like menus.
 	 */
 	@Override
 	public void onInitialize() {

src/main/java/com/tcm/MineTale/block/workbenches/FarmersWorkbench.java

@@ -30,7 +30,7 @@ public class FarmersWorkbench extends AbstractWorkbench<FarmersWorkbenchEntity>
     public static final MapCodec<FarmersWorkbench> CODEC = simpleCodec(FarmersWorkbench::new);
 
     /**
-     * Constructs a FarmersWorkbench that uses the mod's FARMERS_WORKBENCH_BE block entity type.
+     * Creates a FarmersWorkbench preconfigured to use ModBlockEntities.FARMERS_WORKBENCH_BE as its block entity type.
      *
      * @param properties block properties for this workbench
      */
@@ -40,10 +40,10 @@ public FarmersWorkbench(Properties properties) {
     }
 
     /**
-     * Constructs a FarmersWorkbench using the provided block properties and block-entity type supplier.
+     * Create a FarmersWorkbench with the given block properties and a supplier for its block-entity type.
      *
      * @param properties block properties to apply to this workbench
-     * @param supplier   supplier that provides the BlockEntityType for the FarmersWorkbenchEntity
+     * @param supplier supplier that provides the specific BlockEntityType to use for FarmersWorkbenchEntity
      */
     public FarmersWorkbench(Properties properties, Supplier<BlockEntityType<? extends FarmersWorkbenchEntity>> supplier) {
         super(properties, supplier, IS_WIDE, IS_TALL, 1);

src/main/java/com/tcm/MineTale/block/workbenches/entity/FarmersWorkbenchEntity.java

@@ -27,10 +27,12 @@
 public class FarmersWorkbenchEntity extends AbstractWorkbenchEntity {
     protected final ContainerData data = new ContainerData() {
         /**
-         * Retrieves an internal data value by index for UI synchronization.
+         * Provide the container's UI-synchronized integer value for the specified data index.
          *
-         * @param index There is no cook time or anything for this block as it doesnt use it
-         * @return the value associated with {@code index}, or 0 for any other index
+         * This workbench exposes four data slots (indices 0–3); all slots are currently unused and always return 0.
+         *
+         * @param index the data index to read (expected range: 0–3)
+         * @return 0 for the requested index
          */
         @Override
         public int get(int index) {
@@ -40,10 +42,10 @@ public int get(int index) {
         }
 
         /**
-         * No-op for this workbench; data is server-driven and not set client-side.
+         * No-op setter: client-side attempts to change workbench UI data are ignored because the server is authoritative.
          *
-         * `@param` index the data index to set
-         * `@param` value the value to assign (ignored)
+         * @param index the data index (ignored)
+         * @param value the value to assign (ignored)
          */
         @Override
         public void set(int index, int value) {
@@ -62,9 +64,9 @@ public int getCount() {
     };
 
     /**
-     * Creates a FarmersWorkbenchEntity for the specified world position and block state.
+     * Create a FarmersWorkbenchEntity at the given world position and block state.
      *
-     * Sets the entity's scanRadius to 0.0 and tier to 1.
+     * Initializes the workbench tier to 1 and enables pulling from nearby inventories.
      *
      * @param blockPos   the world position of this block entity
      * @param blockState the block state for this block entity
@@ -77,12 +79,10 @@ public FarmersWorkbenchEntity(BlockPos blockPos, BlockState blockState) {
     }
 
     /**
-     * Persist this workbench's state to the given ValueOutput.
-     *
-     * Stores "WorkbenchTier" (int), "ScanRadius" (double), and the full inventory under "Inventory"
-     * using type-safe Codecs.
+     * Writes this workbench's persistent state to the provided output, including the workbench tier,
+     * scan radius, and full inventory (stored under the keys "WorkbenchTier", "ScanRadius", and "Inventory").
      *
-     * @param valueOutput the writer used to serialize this entity's fields
+     * @param valueOutput the output used to serialize this entity's fields
      */
     @Override
     protected void saveAdditional(ValueOutput valueOutput) {
@@ -126,12 +126,12 @@ protected void loadAdditional(ValueInput valueInput) {
     }
 
     /**
-     * Creates the server-side container menu for this workbench's UI.
+     * Create the server-side menu for a player to interact with this workbench and synchronize nearby data to that player.
      *
      * @param syncId the window id used to synchronize the menu with the client
      * @param playerInventory the opening player's inventory
      * @param player the player who opened the menu
-     * @return a FarmersWorkbenchMenu bound to this workbench's inventory and synced data
+     * @return the FarmersWorkbenchMenu bound to this workbench's inventory and synchronization data
      */
     @Override
     public @Nullable AbstractContainerMenu createMenu(int syncId, Inventory playerInventory, Player player) {

src/main/java/com/tcm/MineTale/block/workbenches/menu/AbstractWorkbenchContainerMenu.java

@@ -52,12 +52,19 @@ public void setNetworkedNearbyItems(List<ItemStack> items) {
     }
 
     /**
-     * Gets the list of items found in nearby chests.
+     * Accesses the network-synchronized list of nearby item stacks used to simulate available ingredients.
+     *
+     * @return the live list of {@code ItemStack} instances representing nearby items synchronized from the server; entries may be empty
      */
     public List<ItemStack> getNetworkedNearbyItems() {
         return this.networkedNearbyItems;
     }
 
+    /**
+     * Provide the recipe system used by this workbench menu.
+     *
+     * @return the {@code RecipeType<WorkbenchRecipe>} used to match and retrieve recipes for this workbench
+     */
     public RecipeType<WorkbenchRecipe> getRecipeType() {
         return this.recipeType;
     }