From 852c180bbd01c99e6048c3452dd61e23b78e7e26 Mon Sep 17 00:00:00 2001
From: dordsor21 <dordsor21@gmail.com>
Date: Mon, 7 Feb 2022 00:02:52 +0000
Subject: [PATCH] Javadocs/comments/deprecation

---
 .../main/java/com/plotsquared/core/PlotPlatform.java   |  2 +-
 .../main/java/com/plotsquared/core/location/World.java |  2 +-
 .../main/java/com/plotsquared/core/plot/PlotArea.java  | 10 +++++-----
 .../plotsquared/core/queue/ScopedQueueCoordinator.java |  3 +++
 .../main/java/com/plotsquared/core/util/WorldUtil.java |  2 ++
 5 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/Core/src/main/java/com/plotsquared/core/PlotPlatform.java b/Core/src/main/java/com/plotsquared/core/PlotPlatform.java
index 0ea07a71d..7788a21dc 100644
--- a/Core/src/main/java/com/plotsquared/core/PlotPlatform.java
+++ b/Core/src/main/java/com/plotsquared/core/PlotPlatform.java
@@ -109,7 +109,7 @@ public interface PlotPlatform<P> extends LocaleHolder {
     /**
      * Gets the default maximum world height for the version of Minecraft that the server is running.
      *
-     * @return maximum world height
+     * @return maximum world height (inclusive)
      * @since TODO
      */
     int versionMaxHeight();
diff --git a/Core/src/main/java/com/plotsquared/core/location/World.java b/Core/src/main/java/com/plotsquared/core/location/World.java
index dec73e46b..4473fd1a7 100644
--- a/Core/src/main/java/com/plotsquared/core/location/World.java
+++ b/Core/src/main/java/com/plotsquared/core/location/World.java
@@ -67,7 +67,7 @@ public interface World<T> {
 
 
     /**
-     * Get the max world height. Exclusive.
+     * Get the max world height. Inclusive.
      *
      * @since TODO
      */
diff --git a/Core/src/main/java/com/plotsquared/core/plot/PlotArea.java b/Core/src/main/java/com/plotsquared/core/plot/PlotArea.java
index 1395141fc..378882012 100644
--- a/Core/src/main/java/com/plotsquared/core/plot/PlotArea.java
+++ b/Core/src/main/java/com/plotsquared/core/plot/PlotArea.java
@@ -141,10 +141,10 @@ public abstract class PlotArea {
     private boolean homeAllowNonmember = false;
     private BlockLoc nonmemberHome;
     private BlockLoc defaultHome;
-    private int maxBuildHeight = PlotSquared.platform().versionMaxHeight();
-    private int minBuildHeight = PlotSquared.platform().versionMinHeight() + 1;
-    private int maxGenHeight = PlotSquared.platform().versionMaxHeight();
-    private int minGenHeight = PlotSquared.platform().versionMinHeight();
+    private int maxBuildHeight = PlotSquared.platform().versionMaxHeight() + 1; // Exclusive
+    private int minBuildHeight = PlotSquared.platform().versionMinHeight() + 1; // Inclusive
+    private int maxGenHeight = PlotSquared.platform().versionMaxHeight(); // Inclusive
+    private int minGenHeight = PlotSquared.platform().versionMinHeight(); // Inclusive
     private GameMode gameMode = GameModes.CREATIVE;
     private Map<String, PlotExpression> prices = new HashMap<>();
     private List<String> schematics = new ArrayList<>();
@@ -1365,7 +1365,7 @@ public abstract class PlotArea {
     }
 
     /**
-     * Get the maximum height players may build in. Inclusive.
+     * Get the maximum height players may build in. Exclusive.
      */
     public int getMaxBuildHeight() {
         return this.maxBuildHeight;
diff --git a/Core/src/main/java/com/plotsquared/core/queue/ScopedQueueCoordinator.java b/Core/src/main/java/com/plotsquared/core/queue/ScopedQueueCoordinator.java
index 3b4cb2682..cba1f8a2a 100644
--- a/Core/src/main/java/com/plotsquared/core/queue/ScopedQueueCoordinator.java
+++ b/Core/src/main/java/com/plotsquared/core/queue/ScopedQueueCoordinator.java
@@ -53,6 +53,9 @@ public class ScopedQueueCoordinator extends DelegateQueueCoordinator {
     private final int dy;
     private final int dz;
 
+    /**
+     * Create a new ScopedQueueCoordinator instance that delegates to a given QueueCoordinator. Locations are inclusive.
+     */
     public ScopedQueueCoordinator(@Nullable QueueCoordinator parent, @NonNull Location min, @NonNull Location max) {
         super(parent);
         this.min = min;
diff --git a/Core/src/main/java/com/plotsquared/core/util/WorldUtil.java b/Core/src/main/java/com/plotsquared/core/util/WorldUtil.java
index 1e85cb94d..b5102c2c3 100644
--- a/Core/src/main/java/com/plotsquared/core/util/WorldUtil.java
+++ b/Core/src/main/java/com/plotsquared/core/util/WorldUtil.java
@@ -79,7 +79,9 @@ public abstract class WorldUtil {
      * @param p2x   Max X
      * @param p2z   Max Z
      * @param biome Biome
+     * @deprecated use {@link WorldUtil#setBiome(PlotArea, int, int, int, int, BiomeType)}
      */
+    @Deprecated(forRemoval = true)
     public static void setBiome(String world, int p1x, int p1z, int p2x, int p2z, BiomeType biome) {
         BlockVector3 pos1 = BlockVector2.at(p1x, p1z).toBlockVector3();
         BlockVector3 pos2 = BlockVector2.at(p2x, p2z).toBlockVector3(255);