(experimental) document some deprecated tags in meta

DenizenScript · Oct 28, 2021 · 2b2b05c · 2b2b05c
1 parent 8cd5adb
commit 2b2b05c
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/...in/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java b/...in/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityArmorPose.java
@@ -89,11 +89,29 @@ public static void registerTags() {
             return entity.getPoseMap();
         });
 
+        // <--[tag]
+        // @attribute <EntityTag.armor_pose_list>
+        // @returns ListTag
+        // @mechanism EntityTag.armor_pose
+        // @Deprecated Use 'armor_pose_map'
+        // @group attributes
+        // @description
+        // Deprecated in favor of <@link tag EntityTag.armor_pose_map>
+        // -->
         PropertyParser.<EntityArmorPose, ListTag>registerTag(ListTag.class, "armor_pose_list", (attribute, entity) -> {
             Deprecations.entityArmorPose.warn(attribute.context);
             return entity.getPoseList();
         });
 
+        // <--[tag]
+        // @attribute <EntityTag.armor_pose>
+        // @returns LocationTag
+        // @mechanism EntityTag.armor_pose
+        // @Deprecated Use 'armor_pose_map'
+        // @group attributes
+        // @description
+        // Deprecated in favor of <@link tag EntityTag.armor_pose_map>
+        // -->
         PropertyParser.<EntityArmorPose, LocationTag>registerTag(LocationTag.class, "armor_pose", (attribute, entity) -> {
             Deprecations.entityArmorPose.warn(attribute.context);
             if (!attribute.hasContext(1)) {

diff --git a/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java b/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemEnchantments.java
@@ -119,6 +119,15 @@ public ObjectTag getObjectAttribute(Attribute attribute) {
             return enchants.getObjectAttribute(attribute.fulfill(1));
         }
 
+        // <--[tag]
+        // @attribute <ItemTag.enchantments>
+        // @returns ListTag
+        // @mechanism ItemTag.enchantments
+        // @group properties
+        // @Deprecated Use 'enchantment_types' or 'enchantment_map'
+        // @description
+        // Deprecated in favor of <@link tag ItemTag.enchantment_types> or <@link tag ItemTag.enchantment_map>
+        // -->
         if (attribute.startsWith("enchantments")) {
             Deprecations.itemEnchantmentsLegacy.warn(attribute.context);
             Set<Map.Entry<Enchantment, Integer>> enchantments = getEnchantments();