From fbeb03db5e34408533b2a64404ccc3c714b0e9e2 Mon Sep 17 00:00:00 2001
From: EpicKnarvik97 <kristian.knarvik@knett.no>
Date: Wed, 16 Nov 2022 13:52:27 +0100
Subject: [PATCH] Adds comments for all translatable messages

---
 .../DynmapCitizensTranslatableMessage.java    | 120 ++++++++++++++++++
 src/main/resources/strings.yml                |   2 +-
 2 files changed, 121 insertions(+), 1 deletion(-)

diff --git a/src/main/java/net/knarcraft/dynmapcitizens/formatting/DynmapCitizensTranslatableMessage.java b/src/main/java/net/knarcraft/dynmapcitizens/formatting/DynmapCitizensTranslatableMessage.java
index 4c50c6a..878d474 100644
--- a/src/main/java/net/knarcraft/dynmapcitizens/formatting/DynmapCitizensTranslatableMessage.java
+++ b/src/main/java/net/knarcraft/dynmapcitizens/formatting/DynmapCitizensTranslatableMessage.java
@@ -7,25 +7,145 @@ import net.knarcraft.knarlib.formatting.TranslatableMessage;
  */
 public enum DynmapCitizensTranslatableMessage implements TranslatableMessage {
 
+    /**
+     * The format for the basic description of any sentinel
+     *
+     * <p>Placeholders: {name}, {squad}, {sentinelDetails}</p>
+     */
     SENTINEL_DESCRIPTION,
+
+    /**
+     * The format for the detailed description of any sentinel
+     *
+     * <p>Placeholders: {invincible}, {armor}, {health}, {accuracy}, {damage}, {speed}, {allowKnockback}, {range},
+     * {reach}, {targets}, {avoids},  {ignores}</p>
+     */
     SENTINEL_DETAILS,
+
+    /**
+     * The format for a quest's planner description
+     *
+     * <p>Placeholders: {questCoolDown}, {questFrom}, {questUntil}, {questRepeat}</p>
+     */
     QUESTS_PLANNER_DESCRIPTION,
+
+    /**
+     * The format for a quest's cool-down
+     *
+     * <p>Placeholders: {coolDown}</p>
+     */
     QUESTS_PLANNER_COOL_DOWN,
+
+    /**
+     * The text to display if a quest cannot be repeated
+     */
     QUESTS_PLANNER_UNREPEATABLE,
+
+    /**
+     * The format for a quest's first availability date
+     *
+     * <p>Placeholders: {startDate}</p>
+     */
     QUESTS_PLANNER_FROM,
+
+    /**
+     * The format for a quest's last availability date
+     *
+     * <p>Placeholders: {endDate}</p>
+     */
     QUESTS_PLANNER_UNTIL,
+
+    /**
+     * The format for a quest's repeat delay
+     *
+     * <p>Placeholders: {repeatDelay}</p>
+     */
     QUEST_PLANNER_REPEAT,
+
+    /**
+     * The format for a quest's requirements
+     *
+     * <p>Placeholders: {requirementQuestPoints}, {requirementExp}, {requirementBlockedByQuests},
+     * {requirementRequiredQuests}, {requirementRequiredItems}, {requirementMCMMOSkills}, {requirementPermissions},
+     * {requirementCustom}</p>
+     */
     QUESTS_REQUIREMENTS_FORMAT,
+
+    /**
+     * The format for a quest's quest point requirement
+     *
+     * <p>Placeholders: {questPoints}</p>
+     */
     QUESTS_REQUIREMENTS_QUEST_POINTS,
+
+    /**
+     * The format for a quest's exp requirement
+     *
+     * <p>Placeholders: {exp}</p>
+     */
     QUESTS_REQUIREMENTS_EXP,
+
+    /**
+     * The format for a quest's blocking quests
+     *
+     * <p>Placeholders: {blockingQuests}</p>
+     */
     QUESTS_REQUIREMENTS_BLOCKED_BY_QUEST_FORMAT,
+
+    /**
+     * The format for one of a quest's blocking quests
+     *
+     * <p>Placeholders: {questName}</p>
+     */
     QUESTS_REQUIREMENTS_BLOCKED_BY_QUEST_ITEM,
+
+    /**
+     * The format for a quest's required quests
+     *
+     * <p>Placeholders: {requiredQuests}</p>
+     */
     QUESTS_REQUIREMENTS_REQUIRED_QUEST_FORMAT,
+
+    /**
+     * The format for one of a quest's required quests
+     *
+     * <p>Placeholders: {questName}</p>
+     */
     QUESTS_REQUIREMENTS_REQUIRED_QUEST_ITEM,
+
+    /**
+     * The format for a quest's required items
+     *
+     * <p>Placeholders: {requiredItems}</p>
+     */
     QUESTS_REQUIREMENTS_REQUIRED_ITEM_FORMAT,
+
+    /**
+     * The format for one of a quest's required items
+     *
+     * <p>Placeholders: {itemName}</p>
+     */
     QUESTS_REQUIREMENTS_REQUIRED_ITEM_ITEM,
+
+    /**
+     * The format for a quest's mcMMO skill requirement
+     *
+     * <p>Placeholders: {skill}, {level}</p>
+     */
     QUESTS_REQUIREMENTS_MC_MMO_SKILL,
+
+    /**
+     * The format for a quest's required permissions
+     *
+     * <p>Placeholders: {permissions}</p>
+     */
     QUESTS_REQUIREMENTS_REQUIRED_PERMISSION_FORMAT,
+
+    /**
+     * The format for one of a quest's required permissions
+     *
+     * <p>Placeholders: {permission}</p>
+     */
     QUESTS_REQUIREMENTS_REQUIRED_PERMISSION_ITEM;
 
     @Override
diff --git a/src/main/resources/strings.yml b/src/main/resources/strings.yml
index c2ba5f6..e4c183d 100644
--- a/src/main/resources/strings.yml
+++ b/src/main/resources/strings.yml
@@ -1,6 +1,6 @@
 en:
   SENTINEL_DESCRIPTION: |
-    <h2>name</h2>
+    <h2>{name}</h2>
     <br><b>Squad:</b> {squad}
     {sentinelDetails}
   SENTINEL_DETAILS: |