From 224be307a0f70bad62ebe961d921e83603971481 Mon Sep 17 00:00:00 2001 From: tastybento Date: Wed, 8 Feb 2023 18:40:03 -0800 Subject: [PATCH] Fix JavaDoc errors --- .../bentobox/database/json/adapters/EnumTypeAdapter.java | 2 +- .../flags/worldsettings/CleanSuperFlatListener.java | 1 - .../java/world/bentobox/bentobox/util/ItemParser.java | 8 ++++++++ src/main/java/world/bentobox/bentobox/util/Util.java | 2 +- 4 files changed, 10 insertions(+), 3 deletions(-) diff --git a/src/main/java/world/bentobox/bentobox/database/json/adapters/EnumTypeAdapter.java b/src/main/java/world/bentobox/bentobox/database/json/adapters/EnumTypeAdapter.java index edccf73b8..1daff230b 100644 --- a/src/main/java/world/bentobox/bentobox/database/json/adapters/EnumTypeAdapter.java +++ b/src/main/java/world/bentobox/bentobox/database/json/adapters/EnumTypeAdapter.java @@ -21,7 +21,7 @@ public final class EnumTypeAdapter> extends TypeAdapter { /** - * Bimap to store name <-> enum references + * Bimap to store name,enum pair references */ private final BiMap enumMap = HashBiMap.create(); diff --git a/src/main/java/world/bentobox/bentobox/listeners/flags/worldsettings/CleanSuperFlatListener.java b/src/main/java/world/bentobox/bentobox/listeners/flags/worldsettings/CleanSuperFlatListener.java index 0c5471707..3d91e2586 100644 --- a/src/main/java/world/bentobox/bentobox/listeners/flags/worldsettings/CleanSuperFlatListener.java +++ b/src/main/java/world/bentobox/bentobox/listeners/flags/worldsettings/CleanSuperFlatListener.java @@ -103,7 +103,6 @@ public class CleanSuperFlatListener extends FlagListener { /** * This method clears the chunk from queue in the given world * @param world The world that must be cleared. - * @param cg Chunk generator. */ private void cleanChunk(World world) { diff --git a/src/main/java/world/bentobox/bentobox/util/ItemParser.java b/src/main/java/world/bentobox/bentobox/util/ItemParser.java index 31cc9e197..49335b69e 100644 --- a/src/main/java/world/bentobox/bentobox/util/ItemParser.java +++ b/src/main/java/world/bentobox/bentobox/util/ItemParser.java @@ -182,9 +182,13 @@ public class ItemParser { /** * This method parses array of 6 items into an item stack. * Format: + *
{@code 
      *      POTION:NAME::::QTY
+     * }
* Example: + *
{@code 
      *      POTION:STRENGTH:1:EXTENDED:SPLASH:1
+     * }
* @param part String array that contains 6 elements. * @return Potion with given properties. */ @@ -257,13 +261,17 @@ public class ItemParser { /** * This method parses array of 2 to 3 elements that represents player head. * Format: + *
{@code 
      *    PLAYER_HEAD::QTY
      *    PLAYER_HEAD:
      *    PLAYER_HEAD:QTY
+     * }
* Example: + *
{@code 
      *    PLAYER_HEAD:1
      *    PLAYER_HEAD:BONNe1704
      *    PLAYER_HEAD:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYWY1ZjE1OTg4NmNjNTMxZmZlYTBkOGFhNWY5MmVkNGU1ZGE2NWY3MjRjMDU3MGFmODZhOTBiZjAwYzY3YzQyZSJ9fX0:1
+     * }
* @param part String array that contains at least 2 elements. * @return Player head with given properties. */ diff --git a/src/main/java/world/bentobox/bentobox/util/Util.java b/src/main/java/world/bentobox/bentobox/util/Util.java index c24d839c6..d76f9c12f 100644 --- a/src/main/java/world/bentobox/bentobox/util/Util.java +++ b/src/main/java/world/bentobox/bentobox/util/Util.java @@ -59,7 +59,7 @@ import world.bentobox.bentobox.nms.WorldRegenerator; */ public class Util { /** - * Use standard color code definition: &. + * Use standard color code definition: {@code &}. */ private static final Pattern HEX_PATTERN = Pattern.compile("&#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})"); private static final String NETHER = "_nether";