Clean up javadocs

Author: broken1arrow

Menu Library/src/main/java/org/broken/arrow/library/menu/utility/message/BlacklistItemWrapper.java

@@ -9,18 +9,18 @@
 public class BlacklistItemWrapper {
     private final PlaceholderTranslator.PlaceholderWrapper placeholderWrapper;
     private final ItemStack itemStack;
-    private final int size;
+    private final int amount;
 
     /**
      * Constructs a new wrapper containing blacklisted items data.
      *
      * @param itemStack the blacklisted item stack
-     * @param size      the total number of blacklisted items
+     * @param amount      the total number of blacklisted items
      */
-    public BlacklistItemWrapper(final ItemStack itemStack, final int size) {
+    public BlacklistItemWrapper(final ItemStack itemStack, final int amount) {
         this.placeholderWrapper = new PlaceholderTranslator.PlaceholderWrapper();
         this.itemStack = itemStack;
-        this.size = size;
+        this.amount = amount;
     }
 
     /**
@@ -37,8 +37,8 @@ public ItemStack getItemStack() {
      *
      * @return duplicated stacks count
      */
-    public int getSize() {
-        return size;
+    public int getAmount() {
+        return amount;
     }
 
 
@@ -47,28 +47,26 @@ public int getSize() {
      * key-based placeholders instead of using the default indexed placeholder system.
      *
      * <p>If no custom placeholders are provided, the system falls back to
-     * {@link #retrieveAsPlaceholderData()}, which uses ordered placeholders such as
-     * {@code {0}}, {@code {1}}, {@code {2}}.</p>
+     * {@link #retrieveAsPlaceholderData()}, which uses indexed placeholders such as
+     * <code>{0}</code>, <code>{1}</code>.</p>
      *
-     * <p>When this wrapper contains entries, it is used instead and allows named
-     * placeholders.</p>
+     * <p>When this wrapper contains entries, it overrides the default behavior and
+     * allows the use of named placeholders.</p>
      *
      * <p><b>Example (default indexed placeholders):</b></p>
-     * <pre>
-     * {@code "&fYou can't add more if this &6 {0} &ftype, you get back &6 {2} &fitems. You have added totally &4 {1} &fextra itemstacks"}
-     * </pre>
+     * <pre>{@code
+     * "&fThis item&6 {0}&f are blacklisted and you get {1} back."
+     * }</pre>
      *
      * <p><b>Example (custom named placeholders):</b></p>
-     * <pre>
-     * {@code
+     * <pre>{@code
      * wrapper.put("{type}", itemStack.getType())
-     * .put("{addedStacks}", size)
-     * .put("{returnedItems}", itemAmount);
-     * }
-     * {@code "&fYou can't add more if this &6 {type} &ftype, you get back &6 {returnedItems} &fitems. You have added totally &4 {addedStacks} &fextra itemstacks"}
-     * </pre>
+     *        .put("{amount}", amount);
      *
-     * @return the {@link PlaceholderTranslator.PlaceholderWrapper} for custom placeholders
+     * "&fThis item&6 {type}&f are blacklisted and you get {amount} back."
+     * }</pre>
+     *
+     * @return the {@link PlaceholderTranslator.PlaceholderWrapper} used for custom placeholders
      */
     public PlaceholderTranslator.PlaceholderWrapper getPlaceholderWrapper() {
         return placeholderWrapper;
@@ -81,6 +79,6 @@ public PlaceholderTranslator.PlaceholderWrapper getPlaceholderWrapper() {
      * @return an array of placeholder data objects
      */
     public Object[] retrieveAsPlaceholderData() {
-        return new Object[]{itemStack.getType(), size};
+        return new Object[]{itemStack.getType(), amount};
     }
 }

Menu Library/src/main/java/org/broken/arrow/library/menu/utility/message/DuplicatedItemWrapper.java

@@ -4,94 +4,95 @@
 import org.bukkit.inventory.ItemStack;
 
 /**
-     * Wrapper class holding information about duplicated items for placeholder substitution.
-     */
-    public  class DuplicatedItemWrapper {
-        private final PlaceholderTranslator.PlaceholderWrapper placeholderWrapper;
-        private final ItemStack itemStack;
-        private final int size;
-        private final int itemAmount;
+ * Wrapper class holding information about duplicated items for placeholder substitution.
+ */
+public class DuplicatedItemWrapper {
+    private final PlaceholderTranslator.PlaceholderWrapper placeholderWrapper;
+    private final ItemStack itemStack;
+    private final int size;
+    private final int itemAmount;
 
-        /**
-         * Constructs a new wrapper containing duplicated item data.
-         *
-         * @param itemStack  the duplicated item stack
-         * @param size       the total number of duplicated stacks
-         * @param itemAmount the total number of duplicated items
-         */
-        public DuplicatedItemWrapper(final ItemStack itemStack, final int size, final int itemAmount) {
-            this.placeholderWrapper = new PlaceholderTranslator.PlaceholderWrapper();
-            this.itemStack = itemStack;
-            this.size = size;
-            this.itemAmount = itemAmount;
-        }
+    /**
+     * Constructs a new wrapper containing duplicated item data.
+     *
+     * @param itemStack  the duplicated item stack
+     * @param size       the total number of duplicated stacks
+     * @param itemAmount the total number of duplicated items
+     */
+    public DuplicatedItemWrapper(final ItemStack itemStack, final int size, final int itemAmount) {
+        this.placeholderWrapper = new PlaceholderTranslator.PlaceholderWrapper();
+        this.itemStack = itemStack;
+        this.size = size;
+        this.itemAmount = itemAmount;
+    }
 
-        /**
-         * Returns the duplicated item stack.
-         *
-         * @return the item stack
-         */
-        public ItemStack getItemStack() {
-            return itemStack.clone();
-        }
+    /**
+     * Returns the duplicated item stack.
+     *
+     * @return the item stack
+     */
+    public ItemStack getItemStack() {
+        return itemStack.clone();
+    }
 
-        /**
-         * Returns the total number of duplicated stacks.
-         *
-         * @return duplicated stacks count
-         */
-        public int getSize() {
-            return size;
-        }
+    /**
+     * Returns the total number of duplicated stacks.
+     *
+     * @return duplicated stacks count
+     */
+    public int getSize() {
+        return size;
+    }
 
-        /**
-         * Returns the total number of duplicated items.
-         *
-         * @return duplicated item count
-         */
-        public int getItemAmount() {
-            return itemAmount;
-        }
+    /**
+     * Returns the total number of duplicated items.
+     *
+     * @return duplicated item count
+     */
+    public int getItemAmount() {
+        return itemAmount;
+    }
 
-        /**
-         * Returns a {@link PlaceholderTranslator.PlaceholderWrapper} for defining custom
-         * key-based placeholders instead of using the default indexed placeholder system.
-         *
-         * <p>If no custom placeholders are provided, the system falls back to
-         * {@link #retrieveAsPlaceholderData()}, which uses ordered placeholders such as
-         * {@code {0}}, {@code {1}}, {@code {2}}.</p>
-         *
-         * <p>When this wrapper contains entries, it is used instead and allows named
-         * placeholders.</p>
-         *
-         * <p><b>Example (default indexed placeholders):</b></p>
-         * <pre>
-         * {@code "&fYou can't add more if this &6 {0} &ftype, you get back &6 {2} &fitems. You have added totally &4 {1} &fextra itemstacks"}
-         * </pre>
-         *
-         * <p><b>Example (custom named placeholders):</b></p>
-         * <pre>
-         * {@code
-         * wrapper.put("{type}", itemStack.getType())
-         * .put("{addedStacks}", size)
-         * .put("{returnedItems}", itemAmount);
-         * }
-         * {@code "&fYou can't add more if this &6 {type} &ftype, you get back &6 {returnedItems} &fitems. You have added totally &4 {addedStacks} &fextra itemstacks"}
-         * </pre>
-         *
-         * @return the {@link PlaceholderTranslator.PlaceholderWrapper} for custom placeholders
-         */
-        public PlaceholderTranslator.PlaceholderWrapper getPlaceholderWrapper() {
-            return placeholderWrapper;
-        }
+    /**
+     * Returns a {@link PlaceholderTranslator.PlaceholderWrapper} for defining custom
+     * key-based placeholders instead of using the default indexed placeholder system.
+     *
+     * <p>If no custom placeholders are provided, the system falls back to
+     * {@link #retrieveAsPlaceholderData()}, which uses indexed placeholders such as
+     * <code>{0}</code>, <code>{1}</code>, <code>{2}</code>.</p>
+     *
+     * <p>When this wrapper contains entries, it overrides the default behavior and
+     * allows the use of named placeholders.</p>
+     *
+     * <p><b>Example (default indexed placeholders):</b></p>
+     * <pre>{@code
+     * &fYou can't add more of this &6{0}&f type. You get back &6{2}&f items.
+     * You have added a total of &4{1}&f extra item stacks.
+     * }</pre>
+     *
+     * <p><b>Example (custom named placeholders):</b></p>
+     * <pre>{@code
+     * wrapper.put("{type}", itemStack.getType())
+     *        .put("{addedStacks}", size)
+     *        .put("{returnedItems}", itemAmount);
+     *
+     * "&fYou can't add more of this &6{type}&f type. You get back &6{returnedItems}&f items.
+     * You have added a total of &4{addedStacks}&f extra item stacks."
+     * }</pre>
+     *
+     * @return the {@link PlaceholderTranslator.PlaceholderWrapper} used for custom placeholders
+     */
+    public PlaceholderTranslator.PlaceholderWrapper getPlaceholderWrapper() {
+        return placeholderWrapper;
+    }
 
-        /**
-         * Returns an array of objects to be used as placeholders in messages:
-         * item type, duplicated stacks count, and duplicated items count.
-         *
-         * @return an array of placeholder data objects
-         */
-        public Object[] retrieveAsPlaceholderData() {
-            return new Object[]{itemStack.getType(), size, itemAmount};
-        }
-    }
+    /**
+     * Returns an array of objects to be used as placeholders in messages:
+     * item type, duplicated stacks count, and duplicated items count.
+     *
+     * @return an array of placeholder data objects
+     */
+    public Object[] retrieveAsPlaceholderData() {
+        return new Object[]{itemStack.getType(), size, itemAmount};
+    }
+}