From c2bf0322a7c09c7d8771ca9b2ee517fa0ecfb3f7 Mon Sep 17 00:00:00 2001 From: Craftinators Date: Fri, 17 Mar 2023 09:06:37 -0400 Subject: [PATCH] docs(WGHook): documented class --- .../hmccosmetics/hooks/worldguard/WGHook.java | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/worldguard/WGHook.java b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/worldguard/WGHook.java index dc4541a1..60f4b3ce 100644 --- a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/worldguard/WGHook.java +++ b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/worldguard/WGHook.java @@ -9,9 +9,18 @@ import com.sk89q.worldguard.protection.flags.registry.FlagRegistry; import java.util.logging.Level; +/** + * A hook that integrates the plugin {@link com.sk89q.worldguard.WorldGuard WorldGuard} + */ public class WGHook { - + /** + * @implNote Please use {@link #getCosmeticEnableFlag()} instead + */ public static StateFlag COSMETIC_ENABLE_FLAG; + + /** + * @implNote Please use {@link #getCosmeticWardrobeFlag()} instead + */ public static StateFlag COSMETIC_WARDROBE_FLAG; public WGHook() { @@ -35,10 +44,18 @@ public class WGHook { } } + /** + * Gets the cosmetic enable {@link StateFlag} + * @return The cosmetic enable {@link StateFlag} + */ public static StateFlag getCosmeticEnableFlag() { return COSMETIC_ENABLE_FLAG; } + /** + * Gets the cosmetic wardrobe {@link StateFlag} + * @return The cosmetic wardrobe {@link StateFlag} + */ public static StateFlag getCosmeticWardrobeFlag() { return COSMETIC_WARDROBE_FLAG; }