Address comments regarding javadocs/comments

This commit is contained in:
dordsor21 2022-06-11 13:03:09 +01:00
parent 8d0cc68721
commit 8608604306
No known key found for this signature in database
GPG Key ID: 1E53E88969FFCF0B
4 changed files with 9 additions and 5 deletions

View File

@ -78,7 +78,7 @@ final class BlockStatePopulator extends BlockPopulator {
return; return;
} }
LimitedRegionWrapperQueue wrapped = new LimitedRegionWrapperQueue(limitedRegion); 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. // outside of the actual chunk area.
Location min = UncheckedWorldLocation.at(worldInfo.getName(), chunkX << 4, worldInfo.getMinHeight(), chunkZ << 4); Location min = UncheckedWorldLocation.at(worldInfo.getName(), chunkX << 4, worldInfo.getMinHeight(), chunkZ << 4);
Location max = UncheckedWorldLocation.at( Location max = UncheckedWorldLocation.at(

View File

@ -40,7 +40,7 @@ import org.bukkit.generator.LimitedRegion;
import org.checkerframework.checker.nullness.qual.NonNull; 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 * @since TODO
*/ */

View File

@ -60,7 +60,8 @@ public class StateWrapper {
public CompoundTag tag = null; 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") @Deprecated(forRemoval = true, since = "TODO")
public StateWrapper(org.bukkit.block.BlockState state) { 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") @Deprecated(forRemoval = true, since = "TODO")
public CompoundTag getTag() { public CompoundTag getTag() {

View File

@ -61,7 +61,7 @@ public abstract class IndependentPlotGenerator {
* *
* @param result Queue to write to * @param result Queue to write to
* @param settings PlotArea (settings) * @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 {@link ScopedQueueCoordinator} will be renamed in v7.
*/ */
@Deprecated(forRemoval = true, since = "TODO") @Deprecated(forRemoval = true, since = "TODO")