Improve documentation of deprecated methods

This commit is contained in:
NotMyFault 2021-06-22 18:11:48 +02:00
parent 0e84cf085b
commit 9acf9f4f19
No known key found for this signature in database
GPG Key ID: 158F5701A6AAD00C
9 changed files with 24 additions and 19 deletions

View File

@ -37,7 +37,7 @@ import org.checkerframework.checker.nullness.qual.Nullable;
* @deprecated Deprecated and scheduled for removal without replacement * @deprecated Deprecated and scheduled for removal without replacement
* in favor of the build in setup wizard. * in favor of the build in setup wizard.
*/ */
@Deprecated @Deprecated(forRemoval = true)
@Singleton @Singleton
public class MultiverseWorldManager extends BukkitWorldManager { public class MultiverseWorldManager extends BukkitWorldManager {

View File

@ -29,12 +29,17 @@ import com.plotsquared.core.configuration.caption.TranslatableCaption;
import com.plotsquared.core.player.PlotPlayer; import com.plotsquared.core.player.PlotPlayer;
import com.plotsquared.core.plot.PlotArea; import com.plotsquared.core.plot.PlotArea;
/**
* @deprecated Deprecated in favor of "/plot toggle wea" and scheduled for removal within the next major release.
* <br>
* Other command aliases are "/plot toggle worldedit", "/plot toggle we".
*/
@Deprecated(forRemoval = true)
@CommandDeclaration(command = "chat", @CommandDeclaration(command = "chat",
usage = "/plot chat", usage = "/plot chat",
permission = "plots.chat", permission = "plots.chat",
category = CommandCategory.CHAT, category = CommandCategory.CHAT,
requiredType = RequiredType.PLAYER) requiredType = RequiredType.PLAYER)
@Deprecated
public class Chat extends SubCommand { public class Chat extends SubCommand {
@Override @Override

View File

@ -426,7 +426,7 @@ public class Settings extends Config {
} }
@Deprecated @Deprecated(forRemoval = true)
@Comment("Schematic interface related settings") @Comment("Schematic interface related settings")
public static class Web { public static class Web {

View File

@ -1181,15 +1181,6 @@ public abstract class PlotArea {
return signMaterial; return signMaterial;
} }
/**
* Get the legacy plot sign material before wall signs used a "wall" stance.
*
* @return the legacy sign material.
* @deprecated Use {@link #signMaterial()}. This method is used for 1.13 only and
* will be removed without replacement in favor of {@link #signMaterial()}
* once we remove the support for 1.13.
*/
@Deprecated
public String legacySignMaterial() { public String legacySignMaterial() {
return legacySignMaterial; return legacySignMaterial;
} }
@ -1316,7 +1307,15 @@ public abstract class PlotArea {
return this.signMaterial; return this.signMaterial;
} }
@Deprecated /**
* Get the legacy plot sign material before wall signs used a "wall" stance.
*
* @return the legacy sign material.
* @deprecated Use {@link #signMaterial()}. This method is used for 1.13 only and
* will be removed without replacement in favor of {@link #signMaterial()}
* once we remove the support for 1.13.
*/
@Deprecated(forRemoval = true)
public String getLegacySignMaterial() { public String getLegacySignMaterial() {
return this.legacySignMaterial; return this.legacySignMaterial;
} }

View File

@ -214,7 +214,7 @@ public abstract class PlotManager {
* @return the world height * @return the world height
* @deprecated In favor of custom world heights within 1.17 and therefore scheduled for removal without replacement * @deprecated In favor of custom world heights within 1.17 and therefore scheduled for removal without replacement
*/ */
@Deprecated @Deprecated(forRemoval = true)
public int getWorldHeight() { public int getWorldHeight() {
return 255; return 255;
} }

View File

@ -201,8 +201,10 @@ public abstract class QueueCoordinator {
* @return success or not * @return success or not
* *
* @deprecated Biomes now take XYZ, see {@code setBiome int x, int y, int z} * @deprecated Biomes now take XYZ, see {@code setBiome int x, int y, int z}
* <br>
* Scheduled for removal once we drop the support for versions not supporting 3D biomes.
*/ */
@Deprecated @Deprecated(forRemoval = true)
public abstract boolean setBiome(int x, int z, @NonNull BiomeType biome); public abstract boolean setBiome(int x, int z, @NonNull BiomeType biome);
/** /**

View File

@ -30,7 +30,7 @@ package com.plotsquared.core.util;
* *
* @deprecated Do not use * @deprecated Do not use
*/ */
@Deprecated @Deprecated(forRemoval = true)
public class MainUtil { public class MainUtil {
/** /**

View File

@ -127,7 +127,7 @@ public abstract class SchematicHandler {
this.subscriberFactory = subscriberFactory; this.subscriberFactory = subscriberFactory;
} }
@Deprecated @Deprecated(forRemoval = true)
public static void upload( public static void upload(
@Nullable UUID uuid, @Nullable UUID uuid,
final @Nullable String file, final @Nullable String file,
@ -520,7 +520,7 @@ public abstract class SchematicHandler {
return null; return null;
} }
@Deprecated @Deprecated(forRemoval = true)
public void upload(final CompoundTag tag, UUID uuid, String file, RunnableVal<URL> whenDone) { public void upload(final CompoundTag tag, UUID uuid, String file, RunnableVal<URL> whenDone) {
if (tag == null) { if (tag == null) {
TaskManager.runTask(whenDone); TaskManager.runTask(whenDone);

View File

@ -195,7 +195,6 @@ public abstract class WorldUtil {
*/ */
public abstract void getHighestBlock(@NonNull String world, int x, int z, @NonNull IntConsumer result); public abstract void getHighestBlock(@NonNull String world, int x, int z, @NonNull IntConsumer result);
/** /**
* Get the Y coordinate of the highest non-air block in the world, synchronously * Get the Y coordinate of the highest non-air block in the world, synchronously
* *