📝 Add docstrings to Blacksmith-an-stuff

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

The following files were modified:

* `src/main/java/com/tcm/MineTale/block/workbenches/AlchemistsWorkbench.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/entity/AbstractWorkbenchEntity.java`
* `src/main/java/com/tcm/MineTale/block/workbenches/entity/AlchemistsWorkbenchEntity.java`

Author: coderabbitai[bot]

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

@@ -26,7 +26,7 @@ public class AlchemistsWorkbench extends AbstractWorkbench<AlchemistsWorkbenchEn
     public static final MapCodec<AlchemistsWorkbench> CODEC = simpleCodec(AlchemistsWorkbench::new);
 
     /**
-     * Create a new AlchemistsWorkbench that is configured to use the mod's Alchemists Workbench block entity type.
+     * Constructs a new AlchemistsWorkbench configured to use the mod's Alchemists Workbench block-entity type.
      *
      * @param properties block properties for this workbench
      */
@@ -36,20 +36,20 @@ public AlchemistsWorkbench(Properties properties) {
     }
 
     /**
-     * Create an AlchemistsWorkbench with the given block properties and a supplier for its block-entity type.
+     * Constructs an AlchemistsWorkbench configured with the provided block properties and block-entity type supplier.
      *
-     * @param properties block properties applied to this workbench
+     * @param properties the block properties to apply to this workbench
      * @param supplier   supplier that provides the BlockEntityType for the AlchemistsWorkbenchEntity
      */
     public AlchemistsWorkbench(Properties properties, Supplier<BlockEntityType<? extends AlchemistsWorkbenchEntity>> supplier) {
         super(properties, supplier, IS_WIDE, IS_TALL, 1);
     }
 
     /**
-     * Provides a ticker for workbench block entities when the supplied block entity type matches this block's entity type.
+     * Supplies the ticker used to update this workbench's block entity instances when appropriate.
      *
-     * @param type the block entity type to match against this block's workbench entity type
-     * @return a BlockEntityTicker that updates matching workbench block entities, or {@code null} if the types do not match
+     * @param type the block entity type to check for compatibility with this workbench
+     * @return the BlockEntityTicker that updates matching workbench block entities, or {@code null} if the provided type is not compatible
      */
     @Nullable
     @Override
@@ -59,7 +59,7 @@ public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, Block
     }
 
     /**
-     * Provide the MapCodec used for serialisation and deserialisation of this workbench.
+     * Provides the MapCodec used to serialise and deserialise this workbench.
      *
      * @return the MapCodec for this AlchemistsWorkbench
      */

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

@@ -278,10 +278,10 @@ public void setItem(int slot, ItemStack stack) {
     }
 
     /**
-     * Indicates whether this workbench currently has fuel available to perform crafting.
-     *
-     * @return `true` if the workbench has fuel available, `false` otherwise.
-     */
+ * Indicates whether this workbench currently has fuel available to perform crafting.
+ *
+ * @return {@code true} if the workbench has fuel available, {@code false} otherwise.
+ */
     protected abstract boolean hasFuel();
 
     /**

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

@@ -153,11 +153,9 @@ public RecipeType<WorkbenchRecipe> getWorkbenchRecipeType() {
     }
 
     /**
-     * Determines whether the workbench currently has fuel available.
+     * Report that the workbench has fuel available.
      *
-     * Checks that the entity is in a loaded level and that the configured fuel slot contains an item.
-     *
-     * @return `true` if the entity is in a loaded level and the fuel slot contains an item, `false` otherwise.
+     * @return `true` always.
      */
     @Override
     protected boolean hasFuel() {