JavaDocs for Bukkit Module

Author: PulseBeat02

TODO

@@ -1,7 +1,7 @@
 High Priority Tasks:
-  - Rewrite all JavaDocs (mcav-common, mcav-bukkit)
-  - Clean Up Codebase / Optimize
+  - Rewrite all JavaDocs (mcav-common)
   - Write Documentation for Plugin
+  - Clean Up Codebase / Optimize
 
 Medium Priority Tasks:
   - Create Showcase Video

mcav-bukkit/build.gradle.kts

@@ -6,7 +6,7 @@ plugins {
 dependencies {
 
     // project dependencies
-    paperweight.paperDevBundle("1.21.5-R0.1-SNAPSHOT")
+    paperweight.paperDevBundle("1.21.6-R0.1-SNAPSHOT")
     api("team.unnamed:creative-api:1.7.3")
     api("team.unnamed:creative-serializer-minecraft:1.7.3")
     api("net.bytebuddy:byte-buddy:1.17.5")

mcav-bukkit/src/main/java/me/brandonli/mcav/bukkit/MCAVBukkit.java

@@ -22,10 +22,8 @@
 import org.bukkit.plugin.Plugin;
 
 /**
- * The {@code MCAVBukkit} class is a utility class designed to manage
- * and provide access to a shared {@link Plugin} instance within a Minecraft Bukkit
- * environment. It cannot be instantiated and provides static methods for
- * manipulation and retrieval of a single plugin instance.
+ * The main entry point for Bukkit integration. Requires injection of a plugin instance to load
+ * listeners and schedulers.
  */
 public final class MCAVBukkit {
 
@@ -36,9 +34,9 @@ private MCAVBukkit() {
   }
 
   /**
-   * Injects a Plugin instance into the class for future use.
+   * Injects a Plugin instance. Also initializes palettes and packet listeners.
    *
-   * @param plugin the Plugin instance to be injected
+   * @param plugin the Plugin instance
    */
   public static void inject(final Plugin plugin) {
     PLUGIN = plugin;
@@ -47,9 +45,9 @@ public static void inject(final Plugin plugin) {
   }
 
   /**
-   * Retrieves the plugin instance associated with the application.
+   * Retrieves the plugin instance.
    *
-   * @return the current Plugin instance registered with the application.
+   * @return the current Plugin instance
    */
   public static Plugin getPlugin() {
     return PLUGIN;

mcav-bukkit/src/main/java/me/brandonli/mcav/bukkit/media/config/BlockConfiguration.java

@@ -18,10 +18,14 @@
 package me.brandonli.mcav.bukkit.media.config;
 
 import com.google.common.base.Preconditions;
+import org.bukkit.Location;
+
 import java.util.Collection;
 import java.util.UUID;
-import org.bukkit.Location;
 
+/**
+ * Represents a configuration for block related prototypes.
+ */
 public class BlockConfiguration {
 
   private final Collection<UUID> viewers;
@@ -36,63 +40,133 @@ private BlockConfiguration(final BlockConfiguration.Builder<?> builder) {
     this.position = builder.position;
   }
 
+  /**
+   * Gets the viewers of this block configuration.
+   *
+   * @return the viewers
+   */
   public Collection<UUID> getViewers() {
     return this.viewers;
   }
 
+  /**
+   * Gets the width of the block in blocks.
+   *
+   * @return the block width
+   */
   public int getBlockWidth() {
     return this.blockWidth;
   }
 
+  /**
+   * Gets the height of the block in blocks.
+   *
+   * @return the block height
+   */
   public int getBlockHeight() {
     return this.blockHeight;
   }
 
+  /**
+   * Gets the position of the block.
+   *
+   * @return the position
+   */
   public Location getPosition() {
     return this.position;
   }
 
+  /**
+   * Block configuration builder abstraction.
+   */
   public static final class BlockResultBuilder extends BlockConfiguration.Builder<BlockConfiguration.BlockResultBuilder> {
 
+    BlockResultBuilder() {
+      // no-op
+    }
+
     @Override
     protected BlockConfiguration.BlockResultBuilder self() {
       return this;
     }
   }
 
+  /**
+   * Creates a new block configuration builder.
+   *
+   * @return a new block configuration builder
+   */
   public static BlockConfiguration.Builder<?> builder() {
     return new BlockConfiguration.BlockResultBuilder();
   }
 
+  /**
+   * Abstract builder for block configurations.
+   *
+   * @param <T> the type of the builder
+   */
   public abstract static class Builder<T extends BlockConfiguration.Builder<T>> {
 
     private Collection<UUID> viewers;
     private int blockWidth;
     private int blockHeight;
     private Location position;
 
-    protected abstract T self();
+    Builder() {
+      // no-op
+    }
+
+    abstract T self();
 
+    /**
+     * Sets the viewers of this block configuration.
+     *
+     * @param viewers the viewers to set
+     * @return the builder instance for chaining
+     */
     public T viewers(final Collection<UUID> viewers) {
       this.viewers = viewers;
       return this.self();
     }
 
+    /**
+     * Sets the position of this block configuration.
+     *
+     * @param position the position to set
+     * @return the builder instance for chaining
+     */
     public T position(final Location position) {
       this.position = position;
       return this.self();
     }
 
+    /**
+     * Sets the width of the configuration in blocks.
+     *
+     * @param blockWidth the block width to set
+     * @return the builder instance for chaining
+     */
     public T blockWidth(final int blockWidth) {
       this.blockWidth = blockWidth;
       return this.self();
     }
 
+    /**
+     * Sets the height of the configuration in blocks.
+     *
+     * @param blockHeight the block height to set
+     * @return the builder instance for chaining
+     */
     public T blockHeight(final int blockHeight) {
       this.blockHeight = blockHeight;
       return this.self();
     }
 
+    /**
+     * Builds the block configuration.
+     *
+     * @return a new instance of BlockConfiguration
+     */
     public BlockConfiguration build() {
       Preconditions.checkArgument(this.blockWidth > 0, "Map block width must be positive");
       Preconditions.checkArgument(this.blockHeight > 0, "Map block height must be positive");

mcav-bukkit/src/main/java/me/brandonli/mcav/bukkit/media/config/ChatConfiguration.java

@@ -18,27 +18,12 @@
 package me.brandonli.mcav.bukkit.media.config;
 
 import com.google.common.base.Preconditions;
+
 import java.util.Collection;
 import java.util.UUID;
-import me.brandonli.mcav.bukkit.media.result.ChatResult;
-import me.brandonli.mcav.media.player.pipeline.filter.video.VideoFilter;
 
 /**
- * The {@code ChatConfiguration} class represents a configuration for a chat interface.
- * It holds the parameters required to customize the chat, including the audience,
- * dimensions, and character used for representation.
- * <p>
- * This class is designed to be immutable, and instances are created using
- * its nested {@link Builder} class or its specialized {@link ChatResultBuilder}.
- * <p>
- * Responsibilities:
- * - Defines the configuration properties for chat setup.
- * - Provides accessor methods to retrieve configuration data such as viewers,
- * character, width, and height.
- * <p>
- * The builder pattern ensures that all required properties are properly set
- * before an instance of {@code ChatConfiguration} is created, while also
- * allowing for a fluent interface.
+ * Represents a configuration for chat related prototypes.
  */
 public class ChatConfiguration {
 
@@ -55,72 +40,69 @@ private ChatConfiguration(final Builder<?> builder) {
   }
 
   /**
-   * Retrieves the collection of viewers associated with this configuration.
-   * Each viewer is represented by a unique UUID.
+   * Gets the viewers of this chat configuration.
    *
-   * @return a collection of UUIDs representing the viewers
+   * @return the collection of UUIDs representing the viewers
    */
   public Collection<UUID> getViewers() {
     return this.viewers;
   }
 
   /**
-   * Retrieves the character associated with the chat configuration.
+   * Gets the character string associated with this chat configuration.
    *
-   * @return the character as a string representation
+   * @return the character string, which may represent a specific
    */
   public String getCharacter() {
     return this.character;
   }
 
   /**
-   * Retrieves the width of the chat configuration.
+   * Gets the width of the chat
    *
-   * @return the width of the chat as an integer
+   * @return the chat width
    */
   public int getChatWdith() {
     return this.chatWdith;
   }
 
   /**
-   * Retrieves the height of the chat, which represents the configured vertical size
-   * available for chat display in terms of units or pixels.
+   * Gets the height of the chat
    *
-   * @return the current chat height as an integer
+   * @return the chat height as an integer
    */
   public int getChatHeight() {
     return this.chatHeight;
   }
 
   /**
-   * Builder class for constructing instances of {@link ChatResult}. This class
-   * extends the abstract Builder class and provides concrete implementations
-   * for the required parameters.
+   * Chat configuration builder abstraction.
    */
   public static final class ChatResultBuilder extends Builder<ChatResultBuilder> {
 
+    ChatResultBuilder() {
+      // no-op
+    }
+
     @Override
     protected ChatResultBuilder self() {
       return this;
     }
   }
 
   /**
-   * Creates a new builder instance for constructing a {@link ChatResult} object.
+   * Creates a new chat configuration builder.
    *
-   * @return a new instance of {@link ChatResultBuilder} for building
+   * @return a new chat configuration builder
    */
   public static Builder<?> builder() {
     return new ChatResultBuilder();
   }
 
   /**
-   * Abstract base class for building instances of {@link ChatResult}. This class
-   * provides methods to set the required parameters for constructing a ChatResult
-   * instance. The builder pattern allows for a fluent interface and ensures that
-   * all necessary fields are set before building the final object.
+   * Abstract builder for chat configurations.
    *
-   * @param <T> the type of the builder extending this abstract class
+   * @param <T> the type of the builder
    */
   public abstract static class Builder<T extends Builder<T>> {
 
@@ -129,21 +111,25 @@ public abstract static class Builder<T extends Builder<T>> {
     private int chatWidth;
     private int chatHeight;
 
-    protected abstract T self();
+    Builder() {
+      // no-op
+    }
+
+    abstract T self();
 
     /**
-     * Sets the collection of UUIDs representing the viewers for this builder.
+     * Sets the viewers of this chat configuration.
      *
-     * @param viewers the collection of UUID objects that represent the viewers
-     * @return the builder instance for method chaining
+     * @param viewers the viewers to set
+     * @return the builder instance for chaining
      */
     public T viewers(final Collection<UUID> viewers) {
       this.viewers = viewers;
       return this.self();
     }
 
     /**
-     * Sets the character string for the builder.
+     * Sets the character string of this chat configuration.
      *
      * @param character the character value to be set
      * @return the instance of the builder for method chaining
@@ -154,9 +140,9 @@ public T character(final String character) {
     }
 
     /**
-     * Sets the chat width and returns the builder instance for method chaining.
+     * Sets the chat width of this chat configuration.
      *
-     * @param chatWidth the width of the chat, must be a positive integer
+     * @param chatWidth the width of the chat
      * @return the builder instance for method chaining
      */
     public T chatWidth(final int chatWidth) {
@@ -165,9 +151,9 @@ public T chatWidth(final int chatWidth) {
     }
 
     /**
-     * Sets the height of the chat interface.
+     * Sets the chat height of this chat configuration.
      *
-     * @param chatHeight the height of the chat in pixels; must be a positive integer
+     * @param chatHeight the height of the chat
      * @return the builder instance for method chaining
      */
     public T chatHeight(final int chatHeight) {
@@ -176,14 +162,9 @@ public T chatHeight(final int chatHeight) {
     }
 
     /**
-     * Builds and returns a new instance of {@link VideoFilter} with the configured
-     * parameters. This method validates the provided parameters to ensure the
-     * required fields are set and checks the correctness of the input values.
+     * Builds the chat configuration.
      *
-     * @return a newly constructed {@link VideoFilter} instance.
-     * @throws NullPointerException     if required parameters such as viewers or character
-     *                                  are null.
-     * @throws IllegalArgumentException if chat width or height are non
+     * @return a new instance of ChatConfiguration
      */
     public ChatConfiguration build() {
       Preconditions.checkNotNull(this.viewers);