From 8608604306a893b1bb7ccca8f74bc64eb56c5323 Mon Sep 17 00:00:00 2001 From: dordsor21 Date: Sat, 11 Jun 2022 13:03:09 +0100 Subject: [PATCH] Address comments regarding javadocs/comments --- .../plotsquared/bukkit/generator/BlockStatePopulator.java | 2 +- .../bukkit/queue/LimitedRegionWrapperQueue.java | 2 +- .../com/plotsquared/bukkit/schematic/StateWrapper.java | 8 ++++++-- .../core/generator/IndependentPlotGenerator.java | 2 +- 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/Bukkit/src/main/java/com/plotsquared/bukkit/generator/BlockStatePopulator.java b/Bukkit/src/main/java/com/plotsquared/bukkit/generator/BlockStatePopulator.java index a3a98e827..a635f0e2b 100644 --- a/Bukkit/src/main/java/com/plotsquared/bukkit/generator/BlockStatePopulator.java +++ b/Bukkit/src/main/java/com/plotsquared/bukkit/generator/BlockStatePopulator.java @@ -78,7 +78,7 @@ final class BlockStatePopulator extends BlockPopulator { return; } LimitedRegionWrapperQueue wrapped = new LimitedRegionWrapperQueue(limitedRegion); - // It is possible for the region to be larger than the chunk, but there is not reason for P2 to need to populate + // It is possible for the region to be larger than the chunk, but there is no reason for P2 to need to populate // outside of the actual chunk area. Location min = UncheckedWorldLocation.at(worldInfo.getName(), chunkX << 4, worldInfo.getMinHeight(), chunkZ << 4); Location max = UncheckedWorldLocation.at( diff --git a/Bukkit/src/main/java/com/plotsquared/bukkit/queue/LimitedRegionWrapperQueue.java b/Bukkit/src/main/java/com/plotsquared/bukkit/queue/LimitedRegionWrapperQueue.java index e2bb00574..499c6df9d 100644 --- a/Bukkit/src/main/java/com/plotsquared/bukkit/queue/LimitedRegionWrapperQueue.java +++ b/Bukkit/src/main/java/com/plotsquared/bukkit/queue/LimitedRegionWrapperQueue.java @@ -40,7 +40,7 @@ import org.bukkit.generator.LimitedRegion; import org.checkerframework.checker.nullness.qual.NonNull; /** - * Wraps a {@link LimitedRegion} inside a P2 {@link com.plotsquared.core.queue.QueueCoordinator} so it can be written to. + * Wraps a {@link LimitedRegion} inside a {@link com.plotsquared.core.queue.QueueCoordinator} so it can be written to. * * @since TODO */ diff --git a/Bukkit/src/main/java/com/plotsquared/bukkit/schematic/StateWrapper.java b/Bukkit/src/main/java/com/plotsquared/bukkit/schematic/StateWrapper.java index be3a09178..117a8deb1 100644 --- a/Bukkit/src/main/java/com/plotsquared/bukkit/schematic/StateWrapper.java +++ b/Bukkit/src/main/java/com/plotsquared/bukkit/schematic/StateWrapper.java @@ -60,7 +60,8 @@ public class StateWrapper { public CompoundTag tag = null; /** - * @deprecated in favour of using WE methods for obtaining NBT + * @deprecated in favour of using WE methods for obtaining NBT, specifically by obtaining a + * {@link com.sk89q.worldedit.world.block.BaseBlock} and then using {@link com.sk89q.worldedit.world.block.BaseBlock#getNbtData()} */ @Deprecated(forRemoval = true, since = "TODO") public StateWrapper(org.bukkit.block.BlockState state) { @@ -261,7 +262,10 @@ public class StateWrapper { } /** - * @deprecated in favour of using WE methods for obtaining NBT + * Get a CompoundTag of the contents of a block's inventory (chest, furnace, etc.). + * + * @deprecated in favour of using WE methods for obtaining NBT, specifically by obtaining a + * {@link com.sk89q.worldedit.world.block.BaseBlock} and then using {@link com.sk89q.worldedit.world.block.BaseBlock#getNbtData()} */ @Deprecated(forRemoval = true, since = "TODO") public CompoundTag getTag() { diff --git a/Core/src/main/java/com/plotsquared/core/generator/IndependentPlotGenerator.java b/Core/src/main/java/com/plotsquared/core/generator/IndependentPlotGenerator.java index 4a753255a..d39647f69 100644 --- a/Core/src/main/java/com/plotsquared/core/generator/IndependentPlotGenerator.java +++ b/Core/src/main/java/com/plotsquared/core/generator/IndependentPlotGenerator.java @@ -61,7 +61,7 @@ public abstract class IndependentPlotGenerator { * * @param result Queue to write to * @param settings PlotArea (settings) - * @return True if any population occured + * @return True if any population occurred * @deprecated {@link ScopedQueueCoordinator} will be renamed in v7. */ @Deprecated(forRemoval = true, since = "TODO")