cross link object docs

DenizenScript · Apr 25, 2019 · 68fa941 · 68fa941
1 parent da8b1d1
commit 68fa941
Show file tree

Hide file tree

Showing 15 changed files with 60 additions and 1 deletion.
diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dBiome.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dBiome.java
@@ -24,6 +24,8 @@ public class dBiome implements dObject, Adjustable {
     // A list of all valid Bukkit biomes can found be at
     // <@link url https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Biome.html>
     //
+    // For format info, see <@link language b@>
+    //
     // -->
 
     // <--[language]
@@ -34,6 +36,8 @@ public class dBiome implements dObject, Adjustable {
     // Fetcher. The constructor for a dBiome is the name of a valid biome (in Bukkit).
     // For example, 'b@desert'.
     //
+    // For general info, see <@link language dBiome>
+    //
     // -->
 
     //////////////////

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dChunk.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dChunk.java
@@ -27,6 +27,8 @@ public class dChunk implements dObject, Adjustable {
     // @description
     // A dChunk represents a chunk in the world.
     //
+    // For format info, see <@link language ch@>
+    //
     // -->
 
     // <--[language]
@@ -50,6 +52,8 @@ public class dChunk implements dObject, Adjustable {
     // For example, block at X,Z 32,67 is in the chunk at X,Z 2,4
     // And the block at X,Z -32,-67 is in the chunk at X,Z -2,-5
     //
+    // For general info, see <@link language dChunk>
+    //
     // -->
 
     //////////////////

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dColor.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dColor.java
@@ -23,6 +23,8 @@ public class dColor implements dObject {
     //
     // Note that a dColor is NOT a base dye color (used by wool, etc). That is handled by a separate naming system.
     //
+    // For format info, see <@link language co@>
+    //
     // -->
 
     // <--[language]
@@ -38,6 +40,8 @@ public class dColor implements dObject {
     //
     // Red/green/blue values are each from 0 to 256.
     //
+    // For general info, see <@link language dColor>
+    //
     // -->
 
     final static Pattern rgbPattern = Pattern.compile("(\\d+)[,:](\\d+)[,:](\\d+)");

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dCuboid.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dCuboid.java
@@ -44,6 +44,8 @@ public class dCuboid implements dObject, Cloneable, Notable, Adjustable {
     // One 'cuboid' consists of two points: the low point and a high point.
     // a dCuboid can contain as many cuboids within itself as needed (this allows forming more complex shapes from a single dCuboid).
     //
+    // For format info, see <@link language cu@>
+    //
     // -->
 
     // <--[language]
@@ -54,6 +56,8 @@ public class dCuboid implements dObject, Cloneable, Notable, Adjustable {
     // Fetcher. The constructor for a dCuboid is <x>,<y>,<z>,<world>|...
     // For example, 'cu@1,2,3,space|4,5,6,space'.
     //
+    // For general info, see <@link language dCuboid>
+    //
     // -->
 
     // Cloning

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dEllipsoid.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dEllipsoid.java
@@ -25,6 +25,8 @@ public class dEllipsoid implements dObject, Notable {
     // The word 'ellipsoid' means a less strict sphere.
     // Basically: an "ellipsoid" is to a 3D "sphere" what an "ellipse" (or "oval") is to a 2D "circle".
     //
+    // For format info, see <@link language ellipsoid@>
+    //
     // -->
 
     // <--[language]
@@ -35,6 +37,8 @@ public class dEllipsoid implements dObject, Notable {
     // Fetcher. The constructor for a dEllipsoid is <x>,<y>,<z>,<world>,<x-radius>,<y-radius>,<z-radius>
     // For example, 'ellipsoid@1,2,3,space,7,7,7'.
     //
+    // For general info, see <@link language dEllipsoid>
+    //
     // -->
 
     public static List<dEllipsoid> getNotableEllipsoidsContaining(Location location) {

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dEntity.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dEntity.java
@@ -50,6 +50,8 @@ public class dEntity implements dObject, Adjustable, EntityFormObject {
     // Note that players and NPCs are valid dEntities, but are generally represented by the more specific
     // dPlayer and dNPC objects.
     //
+    // For format info, see <@link language e@>
+    //
     // -->
 
     // <--[language]
@@ -60,6 +62,8 @@ public class dEntity implements dObject, Adjustable, EntityFormObject {
     // Fetcher. The constructor for a dEntity is a spawned entity's UUID, or an entity type.
     // For example, 'e@zombie'.
     //
+    // For general info, see <@link language dEntity>
+    //
     // -->
 
     /////////////////////

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dInventory.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dInventory.java
@@ -47,6 +47,8 @@ public class dInventory implements dObject, Notable, Adjustable {
     // Inventories can be generically designed using inventory script containers,
     // and can be modified using the inventory command.
     //
+    // For format info, see <@link language in@>
+    //
     // -->
 
     // <--[language]
@@ -59,6 +61,8 @@ public class dInventory implements dObject, Notable, Adjustable {
     // Valid inventory type classifications:
     // "npc", "player", "crafting", "enderchest", "workbench", "entity", "location", "generic"
     //
+    // For general info, see <@link language dInventory>
+    //
     // -->
 
     public static dInventory mirrorBukkitInventory(Inventory inventory) {

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dItem.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dItem.java
@@ -53,6 +53,8 @@ public class dItem implements dObject, Notable, Adjustable {
     // dItems do NOT remember where they came from. If you read an item from an inventory, changing it
     // does not change the original item in the original inventory. You must set it back in.
     //
+    // For format info, see <@link language i@>
+    //
     // -->
 
     // <--[language]
@@ -67,6 +69,8 @@ public class dItem implements dObject, Notable, Adjustable {
     // <@link url https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html>
     // Note that some materials on that list are exclusively for use with blocks, and cannot be held as items.
     //
+    // For general info, see <@link language dItem>
+    //
     // -->
 
     final static Pattern ITEM_PATTERN =

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dLocation.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dLocation.java
@@ -52,6 +52,8 @@ public class dLocation extends org.bukkit.Location implements dObject, Notable,
     // @description
     // A dLocation represents a point in the world.
     //
+    // For format info, see <@link language l@>
+    //
     // -->
 
     // <--[language]
@@ -65,6 +67,8 @@ public class dLocation extends org.bukkit.Location implements dObject, Notable,
     // You cannot leave off both the z and the pitch+yaw at the same time.
     // For example, 'l@1,2.15,3,45,90,space' or 'l@7.5,99,3.2'
     //
+    // For general info, see <@link language dLocation>
+    //
     // -->
 
     /**

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dMaterial.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dMaterial.java
@@ -30,6 +30,8 @@ public class dMaterial implements dObject, Adjustable {
     // @description
     // A dMaterial represents a material (a type of block or item).
     //
+    // For format info, see <@link language m@>
+    //
     // -->
 
     // <--[language]
@@ -40,6 +42,8 @@ public class dMaterial implements dObject, Adjustable {
     // Fetcher. The constructor for a dMaterial is the material type name.
     // For example, 'm@stick'.
     //
+    // For general info, see <@link language dMaterial>
+    //
     // -->
 
     /**

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dNPC.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dNPC.java
@@ -49,6 +49,8 @@ public class dNPC implements dObject, Adjustable, InventoryHolder, EntityFormObj
     // @description
     // A dNPC represents an NPC configured through Citizens.
     //
+    // For format info, see <@link language n@>
+    //
     // -->
 
     // <--[language]
@@ -59,6 +61,8 @@ public class dNPC implements dObject, Adjustable, InventoryHolder, EntityFormObj
     // Fetcher. The constructor for a dNPC is the NPC's id number.
     // For example, 'n@5'.
     //
+    // For general info, see <@link language dNPC>
+    //
     // -->
 
     public static dNPC mirrorCitizensNPC(NPC npc) {

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dPlayer.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dPlayer.java
@@ -54,6 +54,8 @@ public class dPlayer implements dObject, Adjustable, EntityFormObject {
     // @description
     // A dPlayer represents a player in the game.
     //
+    // For format info, see <@link language p@>
+    //
     // -->
 
     /////////////////////
@@ -106,6 +108,8 @@ public static Map<String, UUID> getAllPlayers() {
     // Fetcher. The only valid constructor for a dPlayer is the UUID of the player the object should be
     // associated with.
     //
+    // For general info, see <@link language dPlayer>
+    //
     // -->
 
 

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dPlugin.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dPlugin.java
@@ -18,6 +18,8 @@ public class dPlugin implements dObject {
     // @description
     // A dPlugin represents a Bukkit plugin on the server.
     //
+    // For format info, see <@link language pl@>
+    //
     // -->
 
     // <--[language]
@@ -28,6 +30,8 @@ public class dPlugin implements dObject {
     // Fetcher. The constructor for a dPlugin is the plugin's registered name.
     // For example, 'pl@Denizen'.
     //
+    // For general info, see <@link language dPlugin>
+    //
     // -->
 
     //////////////////

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dTrade.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dTrade.java
@@ -37,13 +37,14 @@ public class dTrade implements dObject, Adjustable {
     // first trade offers a sponge for two emeralds for a sponge, can be used up to 10 times, and offers XP upon a
     // successful transaction. The second trade has zero maximum uses and displays a barrier.
     //
-    //
     // <code>
     // open two trades:
     //     type: task
     //     script:
     //     - opentrades li@trade@trade[max_uses=10;inputs=i@emerald[quantity=2];result=i@sponge|trade@trade[result=i@barrier]
     // </code>
+    //
+    // For format info, see <@link language trade@>
     // -->
 
     // <--[language]
@@ -53,6 +54,8 @@ public class dTrade implements dObject, Adjustable {
     // trade@ refers to the 'object identifier' of a dTrade. The 'trade@' is notation for Denizen's Object
     // Fetcher. The constructor for a dNPC is just the text 'trade'. All other data is specified through properties.
     //
+    // For general info, see <@link language Merchant Trades>
+    //
     // -->
 
     //////////////////

diff --git a/plugin/src/main/java/net/aufdemrand/denizen/objects/dWorld.java b/plugin/src/main/java/net/aufdemrand/denizen/objects/dWorld.java
@@ -51,6 +51,8 @@ public static dWorld mirrorBukkitWorld(World world) {
     // @description
     // A dWorld represents a world on the server.
     //
+    // For format info, see <@link language w@>
+    //
     // -->
 
     // <--[language]
@@ -61,6 +63,8 @@ public static dWorld mirrorBukkitWorld(World world) {
     // Fetcher. The only valid constructor for a dWorld is the name of the world it should be
     // associated with. For example, to reference the world named 'world1', use w@world1.
     // World names are case insensitive.
+    //
+    // For general info, see <@link language dWorld>
     // -->