docs: add missing javadoc

AllayMC · Jan 13, 2025 · 629ef3e · 629ef3e
1 parent 990527e
commit 629ef3e
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 0 deletions.
diff --git a/...main/java/org/allaymc/api/blockentity/component/BlockEntityBrewingStandBaseComponent.java b/...main/java/org/allaymc/api/blockentity/component/BlockEntityBrewingStandBaseComponent.java
@@ -4,15 +4,45 @@
  * @author IWareQ
  */
 public interface BlockEntityBrewingStandBaseComponent extends BlockEntityBaseComponent {
+    /**
+     * Get the brew time of this brewing stand.
+     *
+     * @return the brew time of this brewing stand.
+     */
     int getBrewTime();
 
+    /**
+     * Set the brew time of this brewing stand.
+     *
+     * @param time the brew time of this brewing stand.
+     */
     void setBrewTime(int time);
 
+    /**
+     * Get the fuel amount of this brewing stand.
+     *
+     * @return the fuel amount of this brewing stand.
+     */
     int getFuelAmount();
 
+    /**
+     * Set the fuel amount of this brewing stand.
+     *
+     * @param amount the fuel amount of this brewing stand.
+     */
     void setFuelAmount(int amount);
 
+    /**
+     * Get the total fuel of this brewing stand.
+     *
+     * @return the total fuel of this brewing stand.
+     */
     int getFuelTotal();
 
+    /**
+     * Set the total fuel of this brewing stand.
+     *
+     * @param amount the total fuel of this brewing stand.
+     */
     void setFuelTotal(int amount);
 }
diff --git a/api/src/main/java/org/allaymc/api/world/Dimension.java b/api/src/main/java/org/allaymc/api/world/Dimension.java
@@ -886,30 +886,51 @@ default void broadcastPacket(BedrockPacket packet) {
         getPlayers().forEach(player -> player.sendPacket(packet));
     }
 
+    /**
+     * @see #addSound(float, float, float, String, float)
+     */
     default void addSound(Vector3fc pos, String sound) {
         addSound(pos, sound, 1);
     }
 
+    /**
+     * @see #addSound(float, float, float, String, float)
+     */
     default void addSound(Vector3fc pos, String sound, float volume) {
         addSound(pos, sound, volume, 1);
     }
 
+    /**
+     * @see #addSound(float, float, float, String, float)
+     */
     default void addSound(Vector3fc pos, String sound, float volume, float pitch) {
         addSound(pos.x(), pos.y(), pos.z(), sound, volume, pitch);
     }
 
+    /**
+     * @see #addSound(float, float, float, String, float)
+     */
     default void addSound(Vector3ic pos, String sound) {
         addSound(pos, sound, 1);
     }
 
+    /**
+     * @see #addSound(float, float, float, String, float)
+     */
     default void addSound(Vector3ic pos, String sound, float volume) {
         addSound(pos, sound, volume, 1);
     }
 
+    /**
+     * @see #addSound(float, float, float, String, float)
+     */
     default void addSound(Vector3ic pos, String sound, float volume, float pitch) {
         addSound(pos.x(), pos.y(), pos.z(), sound, volume, pitch);
     }
 
+    /**
+     * @see #addSound(float, float, float, String, float)
+     */
     default void addSound(float x, float y, float z, String sound) {
         addSound(x, y, z, sound, 1);
     }