From 12def37194c983cf38dd132bd26bb469245da152 Mon Sep 17 00:00:00 2001
From: dordsor21 <dordsor21@gmail.com>
Date: Sun, 16 Aug 2020 11:34:08 +0100
Subject: [PATCH] clean up some javadoc stuff

---
 .../bukkit/player/BukkitOfflinePlayer.java           |  3 +++
 .../com/plotsquared/bukkit/player/BukkitPlayer.java  |  4 ++++
 .../bukkit/queue/BukkitChunkCoordinator.java         |  2 +-
 .../java/com/plotsquared/bukkit/queue/GenChunk.java  | 12 ++++++++++++
 .../plotsquared/core/events/PlayerAutoPlotEvent.java |  2 ++
 .../core/events/PlayerClaimPlotEvent.java            |  2 ++
 6 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/Bukkit/src/main/java/com/plotsquared/bukkit/player/BukkitOfflinePlayer.java b/Bukkit/src/main/java/com/plotsquared/bukkit/player/BukkitOfflinePlayer.java
index 46d7c294d..13e34166d 100644
--- a/Bukkit/src/main/java/com/plotsquared/bukkit/player/BukkitOfflinePlayer.java
+++ b/Bukkit/src/main/java/com/plotsquared/bukkit/player/BukkitOfflinePlayer.java
@@ -45,6 +45,9 @@ public class BukkitOfflinePlayer implements OfflinePlotPlayer {
     /**
      * Please do not use this method. Instead use BukkitUtil.getPlayer(Player),
      * as it caches player objects.
+     *
+     * @param player Bukkit OfflinePlayer player to convert
+     * @param permissionHandler Permission Profile to be used
      */
     public BukkitOfflinePlayer(@Nonnull final OfflinePlayer player, @Nonnull final
         PermissionHandler permissionHandler) {
diff --git a/Bukkit/src/main/java/com/plotsquared/bukkit/player/BukkitPlayer.java b/Bukkit/src/main/java/com/plotsquared/bukkit/player/BukkitPlayer.java
index 13dc9927b..4d6e36e44 100644
--- a/Bukkit/src/main/java/com/plotsquared/bukkit/player/BukkitPlayer.java
+++ b/Bukkit/src/main/java/com/plotsquared/bukkit/player/BukkitPlayer.java
@@ -78,7 +78,11 @@ public class BukkitPlayer extends PlotPlayer<Player> {
      * <p>Please do not use this method. Instead use
      * BukkitUtil.getPlayer(Player), as it caches player objects.</p>
      *
+     * @param plotAreaManager PlotAreaManager instance
+     * @param eventDispatcher EventDispatcher instance
      * @param player Bukkit player instance
+     * @param econHandler EconHandler instance
+     * @param permissionHandler PermissionHandler instance
      */
     public BukkitPlayer(@Nonnull final PlotAreaManager plotAreaManager, @Nonnull final EventDispatcher eventDispatcher,
         @Nonnull final Player player, @Nullable final EconHandler econHandler, @Nonnull final PermissionHandler permissionHandler) {
diff --git a/Bukkit/src/main/java/com/plotsquared/bukkit/queue/BukkitChunkCoordinator.java b/Bukkit/src/main/java/com/plotsquared/bukkit/queue/BukkitChunkCoordinator.java
index e33672ccf..8d50f7a11 100644
--- a/Bukkit/src/main/java/com/plotsquared/bukkit/queue/BukkitChunkCoordinator.java
+++ b/Bukkit/src/main/java/com/plotsquared/bukkit/queue/BukkitChunkCoordinator.java
@@ -55,7 +55,7 @@ import java.util.function.Consumer;
  * and allows the caller to specify a sink for the loaded chunks. The
  * coordinator will prevent the chunks from being unloaded until the sink
  * has fully consumed the chunk
- * <p>
+ * </p>
  **/
 public final class BukkitChunkCoordinator extends ChunkCoordinator {
 
diff --git a/Bukkit/src/main/java/com/plotsquared/bukkit/queue/GenChunk.java b/Bukkit/src/main/java/com/plotsquared/bukkit/queue/GenChunk.java
index 3d158612f..4ccbdf6a1 100644
--- a/Bukkit/src/main/java/com/plotsquared/bukkit/queue/GenChunk.java
+++ b/Bukkit/src/main/java/com/plotsquared/bukkit/queue/GenChunk.java
@@ -71,6 +71,8 @@ public class GenChunk extends ScopedQueueCoordinator {
 
     /**
      * Set the internal Bukkit chunk data
+     *
+     * @param chunkData Bukkit ChunkData
      */
     public void setChunkData(@Nonnull ChunkData chunkData) {
         this.chunkData = chunkData;
@@ -88,6 +90,8 @@ public class GenChunk extends ScopedQueueCoordinator {
 
     /**
      * Set the chunk being represented
+     *
+     * @param chunk Bukkit Chunk
      */
     public void setChunk(@Nonnull Chunk chunk) {
         this.chunk = chunk;
@@ -96,6 +100,8 @@ public class GenChunk extends ScopedQueueCoordinator {
 
     /**
      * Set the world and XZ of the chunk being represented via {@link ChunkWrapper}
+     *
+     * @param wrap P2 ChunkWrapper
      */
     public void setChunk(@Nonnull ChunkWrapper wrap) {
         chunk = null;
@@ -146,6 +152,12 @@ public class GenChunk extends ScopedQueueCoordinator {
 
     /**
      * Set the in the whole column of XZ
+     *
+     * @param x Relative x location within the chunk (0 - 15)
+     * @param z Relative z location within the chunk (0 - 15)
+     * @param biome Bukkit biome to set
+     *
+     * @return if successful
      */
     public boolean setBiome(int x, int z, @Nonnull Biome biome) {
         if (this.biomeGrid != null) {
diff --git a/Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java b/Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java
index f226addf6..b397321bb 100644
--- a/Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java
+++ b/Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java
@@ -70,6 +70,8 @@ public class PlayerAutoPlotEvent extends PlotEvent implements CancellablePlotEve
 
     /**
      * Set the schematic string used in the claim.
+     *
+     * @param schematic the schematic name
      */
     public void setSchematic(String schematic) {
         this.schematic = schematic;
diff --git a/Core/src/main/java/com/plotsquared/core/events/PlayerClaimPlotEvent.java b/Core/src/main/java/com/plotsquared/core/events/PlayerClaimPlotEvent.java
index ae6fe0b30..518d79e5b 100644
--- a/Core/src/main/java/com/plotsquared/core/events/PlayerClaimPlotEvent.java
+++ b/Core/src/main/java/com/plotsquared/core/events/PlayerClaimPlotEvent.java
@@ -59,6 +59,8 @@ public class PlayerClaimPlotEvent extends PlotPlayerEvent implements Cancellable
 
     /**
      * Set the schematic string used in the claim.
+     *
+     * @param schematic the schematic name
      */
     public void setSchematic(String schematic) {
         this.schematic = schematic;