add basic object type docs

DenizenScript · Jul 28, 2019 · f672fee · f672fee
1 parent be22abb
commit f672fee
Show file tree

Hide file tree

Showing 16 changed files with 386 additions and 0 deletions.
diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java
@@ -14,6 +14,30 @@
 
 public class AreaShopTag implements ObjectTag {
 
+    // <--[language]
+    // @name AreaShopTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, AreaShop
+    // @description
+    // A AreaShopTag represents an AreaShop shop.
+    //
+    // For format info, see <@link language areashop@>
+    //
+    // -->
+
+    // <--[language]
+    // @name areashop@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, AreaShop
+    // @description
+    // areashop@ refers to the 'object identifier' of a AreaShopTag. The 'areashop@' is notation for Denizen's Object
+    // Fetcher. The constructor for a AreaShopTag is <shop_name>
+    // For example, 'areashop@my_shot'.
+    //
+    // For general info, see <@link language AreaShopTag>
+    //
+    // -->
+
     public static AreaShopTag valueOf(String string) {
         return AreaShopTag.valueOf(string, null);
     }

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/factions/FactionTag.java
@@ -18,6 +18,30 @@
 
 public class FactionTag implements ObjectTag {
 
+    // <--[language]
+    // @name FactionTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, Factions
+    // @description
+    // A FactionTag represents a Factions faction.
+    //
+    // For format info, see <@link language faction@>
+    //
+    // -->
+
+    // <--[language]
+    // @name faction@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, Factions
+    // @description
+    // faction@ refers to the 'object identifier' of a FactionTag. The 'faction@' is notation for Denizen's Object
+    // Fetcher. The constructor for a FactionTag is <faction_name>
+    // For example, 'faction@my_faction'.
+    //
+    // For general info, see <@link language FactionTag>
+    //
+    // -->
+
     /////////////////////
     //   OBJECT FETCHER
     /////////////////

diff --git a/...a/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java b/...a/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java
@@ -23,6 +23,30 @@
 
 public class GriefPreventionClaimTag implements ObjectTag, Adjustable {
 
+    // <--[language]
+    // @name GriefPreventionClaimTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, GriefPrevention
+    // @description
+    // A GriefPreventionClaimTag represents a GriefPrevention claim.
+    //
+    // For format info, see <@link language gpclaim@>
+    //
+    // -->
+
+    // <--[language]
+    // @name gpclaim@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, GriefPrevention
+    // @description
+    // gpclaim@ refers to the 'object identifier' of a GriefPreventionClaimTag. The 'gpclaim@' is notation for Denizen's Object
+    // Fetcher. The constructor for a GriefPreventionClaimTag is <claim_id>
+    // For example, 'gpclaim@1234'.
+    //
+    // For general info, see <@link language GriefPreventionClaimTag>
+    //
+    // -->
+
     static DataStore dataStore = GriefPrevention.instance.dataStore;
 
     public static boolean matches(String id) {

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/jobs/JobsJobTag.java
@@ -17,6 +17,30 @@
 
 public class JobsJobTag implements ObjectTag {
 
+    // <--[language]
+    // @name JobsJobTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, Jobs
+    // @description
+    // A JobsJobTag represents a Jobs job.
+    //
+    // For format info, see <@link language job@>
+    //
+    // -->
+
+    // <--[language]
+    // @name job@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, Jobs
+    // @description
+    // job@ refers to the 'object identifier' of a JobsJobTag. The 'job@' is notation for Denizen's Object
+    // Fetcher. The constructor for a JobsJobTag is <job_name>
+    // For example, 'job@job_name'.
+    //
+    // For general info, see <@link language JobsJobTag>
+    //
+    // -->
+
     /////////////////////
     //   OBJECT FETCHER
     /////////////////

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/libsdisguises/LibsDisguiseTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/libsdisguises/LibsDisguiseTag.java
@@ -13,6 +13,31 @@
 import java.util.List;
 
 public class LibsDisguiseTag implements ObjectTag {
+
+    // <--[language]
+    // @name LibsDisguiseTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, LibsDisguises
+    // @description
+    // A LibsDisguiseTag represents a LibsDisguises disguise type.
+    //
+    // For format info, see <@link language libsdisguise@>
+    //
+    // -->
+
+    // <--[language]
+    // @name libsdisguise@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, LibsDisguises
+    // @description
+    // libsdisguise@ refers to the 'object identifier' of a LibsDisguiseTag. The 'libsdisguise@' is notation for Denizen's Object
+    // Fetcher. The constructor for a LibsDisguiseTag is <disguise_name>
+    // For example, 'libsdisguise@zombie'.
+    //
+    // For general info, see <@link language LibsDisguiseTag>
+    //
+    // -->
+
     /////////////////////
     //   OBJECT FETCHER
     /////////////////

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsTrackTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/luckperms/LuckPermsTrackTag.java
@@ -12,6 +12,31 @@
 import com.denizenscript.denizencore.tags.TagContext;
 
 public class LuckPermsTrackTag implements ObjectTag {
+
+    // <--[language]
+    // @name LuckPermsTrackTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, LuckPerms
+    // @description
+    // A LuckPermsTrackTag represents a LuckPerms track.
+    //
+    // For format info, see <@link language luckpermstrack@>
+    //
+    // -->
+
+    // <--[language]
+    // @name luckpermstrack@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, LuckPerms
+    // @description
+    // luckpermstrack@ refers to the 'object identifier' of a LuckPermsTrackTag. The 'luckpermstrack@' is notation for Denizen's Object
+    // Fetcher. The constructor for a LuckPermsTrackTag is <track_name>
+    // For example, 'luckpermstrack@my_track'.
+    //
+    // For general info, see <@link language LuckPermsTrackTag>
+    //
+    // -->
+
     /////////////////////
     //   OBJECT FETCHER
     /////////////////

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/mcmmo/PartyTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/mcmmo/PartyTag.java
@@ -17,6 +17,30 @@
 
 public class PartyTag implements ObjectTag {
 
+    // <--[language]
+    // @name PartyTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, McMMO
+    // @description
+    // A PartyTag represents an McMMO party.
+    //
+    // For format info, see <@link language party@>
+    //
+    // -->
+
+    // <--[language]
+    // @name party@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, McMMO
+    // @description
+    // party@ refers to the 'object identifier' of a PartyTag. The 'party@' is notation for Denizen's Object
+    // Fetcher. The constructor for a PartyTag is <party_name>
+    // For example, 'party@my_party'.
+    //
+    // For general info, see <@link language PartyTag>
+    //
+    // -->
+
     public static PartyTag valueOf(String string) {
         return PartyTag.valueOf(string, null);
     }

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java
@@ -15,6 +15,30 @@
 
 public class MobArenaArenaTag implements ObjectTag {
 
+    // <--[language]
+    // @name MobArenaArenaTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, MobArena
+    // @description
+    // A MobArenaArenaTag represents a mob arena in the world.
+    //
+    // For format info, see <@link language mobarena@>
+    //
+    // -->
+
+    // <--[language]
+    // @name mobarena@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, MobArena
+    // @description
+    // mobarena@ refers to the 'object identifier' of a MobArenaArenaTag. The 'mobarena@' is notation for Denizen's Object
+    // Fetcher. The constructor for a MobArenaArenaTag is <arena_name>
+    // For example, 'mobarena@my_arena'.
+    //
+    // For general info, see <@link language MobArenaArenaTag>
+    //
+    // -->
+
     String prefix = "MobArena";
     Arena arena = null;
 

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java
@@ -20,6 +20,30 @@
 
 public class MythicMobsMobTag implements ObjectTag, Adjustable {
 
+    // <--[language]
+    // @name MythicMobsMobTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, MythicMobs
+    // @description
+    // A MythicMobsMobTag represents a Mythic mob entity in the world.
+    //
+    // For format info, see <@link language mythicmob@>
+    //
+    // -->
+
+    // <--[language]
+    // @name mythicmob@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, MythicMobs
+    // @description
+    // mythicmob@ refers to the 'object identifier' of a MythicMobsMobTag. The 'mythicmob@' is notation for Denizen's Object
+    // Fetcher. The constructor for a MythicMobsMobTag is <uuid>
+    // For example, 'mythicmob@1234-1234-1234'.
+    //
+    // For general info, see <@link language MythicMobsMobTag>
+    //
+    // -->
+
     public static MythicMobsMobTag valueOf(String uuid) {
         return valueOf(uuid, null);
     }

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java
@@ -22,6 +22,30 @@
 
 public class PlotSquaredPlotTag implements ObjectTag {
 
+    // <--[language]
+    // @name PlotSquaredPlotTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, PlotSquared
+    // @description
+    // A PlotSquaredPlotTag represents a PlotSquared plot in the world.
+    //
+    // For format info, see <@link language plotsquaredplot@>
+    //
+    // -->
+
+    // <--[language]
+    // @name plotsquaredplot@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, PlotSquared
+    // @description
+    // plotsquaredplot@ refers to the 'object identifier' of a PlotSquaredPlotTag. The 'plotsquaredplot@' is notation for Denizen's Object
+    // Fetcher. The constructor for a PlotSquaredPlotTag is <x>,<z>,<world>
+    // For example, 'plotsquaredplot@5,10,Hub'.
+    //
+    // For general info, see <@link language PlotSquaredPlotTag>
+    //
+    // -->
+
     /////////////////////
     //   OBJECT FETCHER
     /////////////////

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/pvparena/PVPArenaArenaTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/pvparena/PVPArenaArenaTag.java
@@ -13,6 +13,30 @@
 
 public class PVPArenaArenaTag implements ObjectTag {
 
+    // <--[language]
+    // @name PVPArenaArenaTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, PvPArena
+    // @description
+    // A PVPArenaArenaTag represents a PvP Arena in the world.
+    //
+    // For format info, see <@link language pvparena@>
+    //
+    // -->
+
+    // <--[language]
+    // @name pvparena@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, PvPArena
+    // @description
+    // pvparena@ refers to the 'object identifier' of a PVPArenaArenaTag. The 'pvparena@' is notation for Denizen's Object
+    // Fetcher. The constructor for a PVPArenaArenaTag is <arena_name>
+    // For example, 'pvparena@myarena'.
+    //
+    // For general info, see <@link language PVPArenaArenaTag>
+    //
+    // -->
+
     String prefix = "PVPArena";
     Arena arena = null;
 

diff --git a/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java b/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java
@@ -14,6 +14,30 @@
 
 public class ResidenceTag implements ObjectTag {
 
+    // <--[language]
+    // @name ResidenceTag
+    // @group Depenizen Object Types
+    // @plugin Depenizen, Residence
+    // @description
+    // A ResidenceTag represents a Residence in the world.
+    //
+    // For format info, see <@link language residence@>
+    //
+    // -->
+
+    // <--[language]
+    // @name residence@
+    // @group Depenizen Object Fetcher Types
+    // @plugin Depenizen, Residence
+    // @description
+    // residence@ refers to the 'object identifier' of a ResidenceTag. The 'residence@' is notation for Denizen's Object
+    // Fetcher. The constructor for a ResidenceTag is <residence_name>
+    // For example, 'residence@myresidence'.
+    //
+    // For general info, see <@link language ResidenceTag>
+    //
+    // -->
+
     public static ResidenceTag valueOf(String string) {
         return ResidenceTag.valueOf(string, null);
     }