📝 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/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`

These files were kept as they were:
* `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/registry/ModRecipes.java`

Author: coderabbitai[bot]

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

@@ -24,15 +24,15 @@
 
 public class MineTaleClient implements ClientModInitializer {
 	/**
-	 * Initializes client-side handlers for the MineTale mod.
+	 * Initialises client-side handlers for the MineTale mod.
 	 *
-	 * 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.
+	 * Registers screen factories for custom workbench menu types, configures render
+	 * layers for furnace workbench blocks, and registers a global network receiver
+	 * that applies nearby inventory items to an open workbench menu.
 	 *
-	 * 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.
+	 * The network receiver schedules work on the client thread and retries application
+	 * for up to 10 client ticks if the expected workbench menu is not yet open; if
+	 * synchronization still fails it logs a failure message.
 	 */
 	@Override
 	public void onInitializeClient() {

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

@@ -88,12 +88,12 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(ArmorersWor
     }
 
     /**
-         * 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.
-         */
+     * Initialises the screen size and adds the three crafting buttons.
+     *
+     * Sets the GUI image dimensions, delegates further initialisation to the superclass,
+     * and creates/registers three buttons wired to craft one, ten or all items
+     * (they invoke handleCraftRequest with 1, 10 and -1 respectively; -1 signifies "All").
+     */
     @Override
     protected void init() {
         // Important: Set your GUI size before super.init()

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

@@ -90,11 +90,12 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(FarmersWork
     }
 
     /**
-     * Configure the screen layout size and initialize crafting widgets.
+     * Initialises the screen layout and registers the crafting controls.
      *
-     * 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.
+     * Sets the GUI dimensions to 176×166 and adds three buttons wired to craft requests:
+     * - "Craft" requests 1,
+     * - "x10" requests 10,
+     * - "All" requests all (represented by -1).
      */
     @Override
     protected void init() {
@@ -257,16 +258,13 @@ private boolean canCraft(Player player, RecipeDisplayEntry entry, int craftCount
     }
 
     /**
-     * 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.
+     * Determine whether the player inventory together with the workbench's networked nearby items
+     * contains at least the specified quantity of items matching the given 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 inventory     the player's inventory to check
+     * @param ingredient    the ingredient matcher used to test item stacks
      * @param totalRequired the total number of matching items required
-     * @return `true` if the combined sources contain at least `totalRequired` matching items, `false` otherwise
+     * @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 + "...");
@@ -303,10 +301,10 @@ private boolean hasIngredientAmount(Inventory inventory, Ingredient ingredient,
     }
 
     /**
-     * Computes the on-screen position for the recipe book toggle button for this GUI.
-     *
-     * @return the screen position placed 5 pixels from the GUI's left edge and 49 pixels above the GUI's vertical center
-     */
+         * Get the screen position for the recipe book toggle button.
+         *
+         * @return the ScreenPosition located 5 pixels from the GUI's left edge and 49 pixels above the GUI's vertical centre
+         */
     @Override
     protected ScreenPosition getRecipeBookButtonPosition() {
         // 1. Calculate the start (left) of your workbench GUI

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

@@ -90,12 +90,14 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(WorkbenchWo
     }
 
     /**
-         * 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.
-         */
+     * Initialises the workbench screen's GUI size and interactive widgets.
+     *
+     * Sets the screen image dimensions, delegates remaining setup to the superclass,
+     * computes default button positions and creates three craft buttons:
+     * - "Craft" (requests 1),
+     * - "x10" (requests 10),
+     * - "All" (requests -1 to indicate all).
+     */
     @Override
     protected void init() {
         // Important: Set your GUI size before super.init()
@@ -147,12 +149,12 @@ private void handleCraftRequest(int amount) {
     }
 
     /**
-    * Draws the workbench GUI background texture at the screen's top-left corner.
+    * Draws the workbench background texture at the screen's current GUI origin.
     *
     * @param guiGraphics the graphics context used to draw GUI elements
     * @param f           partial tick time for interpolation
-    * @param i           current mouse x coordinate relative to the window
-    * @param j           current mouse y coordinate relative to the window
+    * @param i           current mouse x coordinate
+    * @param j           current mouse y coordinate
     */
    protected void renderBg(GuiGraphics guiGraphics, float f, int i, int j) {
       int k = this.leftPos;
@@ -161,12 +163,11 @@ protected void renderBg(GuiGraphics guiGraphics, float f, int i, int j) {
    }
 
     /**
-     * Renders the screen, updates the remembered recipe selection, and enables or disables craft buttons based on the player's available ingredients.
+     * Render the screen, remember the current recipe selection and update craft-button availability.
      *
-     * <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>
+     * Remembers the recipe selected in the recipe book, resolves that selection against the client's known recipes when possible,
+     * sets the craft buttons active or inactive according to whether the player has sufficient ingredients for counts of 1, 2 and 10,
+     * renders the background, the superclass UI and any tooltips.
      */
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {

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

@@ -42,11 +42,12 @@ public class MineTale implements ModInitializer {
 	public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID);
 
 	/**
-	 * Initialize and register the mod's game content, network payloads, and runtime subsystems on startup.
+	 * Initialise the mod: register game content, networking codecs and runtime subsystems.
 	 *
-	 * <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.
+	 * Performs startup registration in dependency order (blocks, items, block entities, entities,
+	 * menus, recipes and recipe displays), registers the creative tab and entity data serializers,
+	 * synchronises the furnace recipe serializer, applies loot-table modifiers, 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);
 
     /**
-     * Creates a FarmersWorkbench preconfigured to use ModBlockEntities.FARMERS_WORKBENCH_BE as its block entity type.
+     * Initialise a FarmersWorkbench that uses the mod's FARMERS_WORKBENCH_BE block-entity type and default size.
      *
      * @param properties block properties for this workbench
      */
@@ -40,10 +40,10 @@ public FarmersWorkbench(Properties properties) {
     }
 
     /**
-     * Create a FarmersWorkbench with the given block properties and a supplier for its block-entity type.
+     * Constructs a FarmersWorkbench with the supplied block properties and block-entity type supplier.
      *
      * @param properties block properties to apply to this workbench
-     * @param supplier supplier that provides the specific BlockEntityType to use for FarmersWorkbenchEntity
+     * @param supplier supplier of the BlockEntityType to use for the workbench's block entity
      */
     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

@@ -42,10 +42,10 @@ public int get(int index) {
         }
 
         /**
-         * No-op setter: client-side attempts to change workbench UI data are ignored because the server is authoritative.
+         * Ignore attempts to modify the workbench's container data from the client; changes are a no-op.
          *
-         * @param index the data index (ignored)
-         * @param value the value to assign (ignored)
+         * @param index the data slot index (ignored)
+         * @param value the value provided (ignored)
          */
         @Override
         public void set(int index, int value) {

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

@@ -44,8 +44,12 @@ public abstract class AbstractWorkbenchContainerMenu extends RecipeBookMenu impl
     private List<ItemStack> networkedNearbyItems = new ArrayList<>();
 
     /**
-     * Updates the list of items available from nearby chests.
-     * Called by the networking system when a sync packet arrives.
+     * Replace the cached list of nearby item stacks supplied by the server for recipe simulation.
+     *
+     * Updates the menu's networked nearby-items list with the provided stacks; this list is used
+     * when the recipe book or placement logic simulates available ingredients from nearby inventories.
+     *
+     * @param items the new list of nearby ItemStack instances received from the server
      */
     public void setNetworkedNearbyItems(List<ItemStack> items) {
         this.networkedNearbyItems = items;
@@ -61,31 +65,31 @@ public List<ItemStack> getNetworkedNearbyItems() {
     }
 
     /**
-     * Provide the recipe system used by this workbench menu.
+     * The recipe type used to match recipes for this workbench.
      *
-     * @return the {@code RecipeType<WorkbenchRecipe>} used to match and retrieve recipes for this workbench
+     * @return the RecipeType for WorkbenchRecipe instances, or {@code null} if no recipe type was provided
      */
     public RecipeType<WorkbenchRecipe> getRecipeType() {
         return this.recipeType;
     }
 
     /**
-     * Constructs a workbench container menu, initializes inventory and sync state, and opens the container for the player.
+     * Initialise a workbench container menu, attach the player inventory and hotbar, and open the backing container for the player.
      *
-     * The constructor conditionally validates container size and attaches container data slots only when the container actually
-     * contains slots (i.e., when `outputEnd >= 0` and the container size is > 0). For slotless workbenches it only verifies the
-     * container is non-null with size 0. If the container has slots, workbench-specific slots are added; the player's inventory
-     * and hotbar are always added. The container is opened for the provided player.
+     * If the backing container provides slots (determined by a non-negative `outputEnd` and a positive container size),
+     * container size and data slot counts are validated and the provided `data` is attached for progress syncing; when the
+     * container is slotless the constructor validates an empty container and skips slot/data attachment.
      *
-     * @param menuType            the menu type or null for an unregistered type
-     * @param syncId              synchronization id for the menu
-     * @param container           the underlying container backing this menu
-     * @param data                container data used to sync progress/state (e.g., burn/cook times)
-     * @param containerDataSize   expected size of `data` when the container provides slots; used for data count validation
-     * @param playerInventory     the player's inventory to attach to this menu
-     * @param inputEnd            index (inclusive) of the last input slot in the container
-     * @param outputEnd           index (inclusive) of the last output slot in the container; if negative or container is empty,
-     *                            the menu is treated as slotless and slot/data initialization is skipped
+     * @param menuType          the menu type, or {@code null} for an unregistered type
+     * @param syncId            synchronization id for this menu instance
+     * @param container         the backing container for workbench slots (may be empty for slotless workbenches)
+     * @param data              container data used to sync progress/state (e.g. burn/cook times)
+     * @param containerDataSize expected size of {@code data} when the container provides slots; used for validation
+     * @param playerInventory   the player's inventory to attach to the menu and to open the container for
+     * @param inputEnd          inclusive index of the last input slot in {@code container}
+     * @param outputEnd         inclusive index of the last output slot in {@code container}; negative or empty container
+     *                          indicates a slotless workbench
+     * @param recipeType        the recipe type used by this workbench, or {@code null} if none
      */
     public AbstractWorkbenchContainerMenu(@Nullable MenuType<?> menuType, int syncId, Container container, ContainerData data, int containerDataSize, Inventory playerInventory, int inputEnd, int outputEnd, RecipeType<WorkbenchRecipe> recipeType) {
         super(menuType, syncId);

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

@@ -37,13 +37,13 @@ public ArmorersWorkbenchMenu(int syncId, Inventory playerInventory) {
     }
 
     /**
-     * Creates a workbench menu associated with the given player inventory and optional block entity.
+     * Creates a workbench menu bound to the given player inventory and optional block entity.
      *
-     * Uses an empty internal container (size 0) and the class's data size for syncing numeric state.
+     * Uses an empty internal container (size 0) and the class's data size to synchronise numeric state.
      *
-     * @param syncId synchronization id for this menu
+     * @param syncId the synchronisation id for this menu
      * @param playerInventory the player's inventory used for slot access and recipe-book integration
-     * @param data container data used to sync numeric state between server and client
+     * @param data container data used to synchronise numeric state between server and client
      * @param blockEntity nullable block entity this menu is bound to, or {@code null} if not bound
      */
     public ArmorersWorkbenchMenu(int syncId, Inventory playerInventory, ContainerData data, @Nullable AbstractWorkbenchEntity blockEntity) {

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

@@ -24,26 +24,25 @@ public class CampfireWorkbenchMenu extends AbstractWorkbenchContainerMenu {
     private final AbstractWorkbenchEntity blockEntity;
 
     /**
-     * Creates a CampfireWorkbenchMenu using default internal storage and data containers.
+     * Create a CampfireWorkbenchMenu initialised with the default internal inventory and data containers.
      *
-     * Constructs a menu with a new SimpleContainer of size {@code containerSize} and a new
-     * SimpleContainerData of size {@code containerDataSize}, then delegates to the primary constructor.
+     * The menu is constructed with a 7‑slot internal container and a data container sized by {@code containerDataSize}.
      *
-     * @param syncId          synchronization id for the menu
+     * @param syncId          the synchronization id for this menu
      * @param playerInventory the player's inventory interacting with this menu
      */
     public CampfireWorkbenchMenu(int syncId, Inventory playerInventory) {
         this(syncId, playerInventory, new SimpleContainer(7), new SimpleContainerData(containerDataSize), null);
     }
 
     /**
-     * Constructs a CampfireWorkbenchMenu connected to the given player inventory, container, and container data.
+     * Create a CampfireWorkbenchMenu bound to the given player inventory, container and container data.
      *
-     * @param syncId the synchronization id for this menu used for client/server container sync
+     * @param syncId the synchronisation id used for client–server container sync
      * @param playerInventory the player's inventory
-     * @param container the backing container for the workbench slots
-     * @param data the container data used for syncing additional numeric state
-     * @param blockEntity the associated workbench block entity, or `null` if not bound to a block
+     * @param container the backing container that provides the workbench slots
+     * @param data the container data used to synchronise numeric state
+     * @param blockEntity the associated workbench block entity, or {@code null} if not bound to a block
      */
     public CampfireWorkbenchMenu(int syncId, Inventory playerInventory, Container container, ContainerData data, @Nullable AbstractWorkbenchEntity blockEntity) {
         super(ModMenuTypes.CAMPFIRE_WORKBENCH_MENU, syncId, container, data, containerDataSize, playerInventory, Constants.INPUT_START + 1, 6, ModRecipes.CAMPFIRE_TYPE);