mirror of
https://github.com/TotalFreedomMC/TF-PlotSquared.git
synced 2024-12-23 00:15:06 +00:00
Fix javadoc generation issues
This commit is contained in:
parent
6c1caac731
commit
5a6dbfda36
7 changed files with 16 additions and 23 deletions
|
@ -54,7 +54,7 @@ public interface Configuration extends ConfigurationSection {
|
||||||
* collection, then a new {@link MemoryConfiguration} will be created to
|
* collection, then a new {@link MemoryConfiguration} will be created to
|
||||||
* hold the new default values.</p>
|
* hold the new default values.</p>
|
||||||
*
|
*
|
||||||
* @param defaults A map of Path->Values to add to defaults.
|
* @param defaults A map of Path->Values to add to defaults.
|
||||||
* @throws IllegalArgumentException Thrown if defaults is null.
|
* @throws IllegalArgumentException Thrown if defaults is null.
|
||||||
*/
|
*/
|
||||||
void addDefaults(Map<String, Object> defaults);
|
void addDefaults(Map<String, Object> defaults);
|
||||||
|
|
|
@ -170,7 +170,7 @@ public abstract class FileConfiguration extends MemoryConfiguration {
|
||||||
* Compiles the header for this FileConfiguration and returns the
|
* Compiles the header for this FileConfiguration and returns the
|
||||||
* result.
|
* result.
|
||||||
*
|
*
|
||||||
* <p>This will use the header from {@link #options()} -> {@link
|
* <p>This will use the header from {@link #options()} -> {@link
|
||||||
* FileConfigurationOptions#header()}, respecting the rules of {@link
|
* FileConfigurationOptions#header()}, respecting the rules of {@link
|
||||||
* FileConfigurationOptions#copyHeader()} if set.
|
* FileConfigurationOptions#copyHeader()} if set.
|
||||||
*
|
*
|
||||||
|
|
|
@ -33,11 +33,11 @@ import java.util.Map;
|
||||||
* the methods as defined by this interface:
|
* the methods as defined by this interface:
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>A static method "deserialize" that accepts a single {@link Map}<
|
* <li>A static method "deserialize" that accepts a single {@link Map}<
|
||||||
* {@link String}, {@link Object}> and returns the class.</li>
|
* {@link String}, {@link Object}> and returns the class.</li>
|
||||||
* <li>A static method "valueOf" that accepts a single {@link Map}<{@link
|
* <li>A static method "valueOf" that accepts a single {@link Map}<{@link
|
||||||
* String}, {@link Object}> and returns the class.</li>
|
* String}, {@link Object}> and returns the class.</li>
|
||||||
* <li>A constructor that accepts a single {@link Map}<{@link String},
|
* <li>A constructor that accepts a single {@link Map}<{@link String},
|
||||||
* {@link Object}>.</li>
|
* {@link Object}>.</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
* In addition to implementing this interface, you must register the class
|
* In addition to implementing this interface, you must register the class
|
||||||
* with {@link ConfigurationSerialization#registerClass(Class)}.
|
* with {@link ConfigurationSerialization#registerClass(Class)}.
|
||||||
|
|
|
@ -398,11 +398,11 @@ import java.util.zip.ZipInputStream;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if `version` is >= `version2`.
|
* Check if `version` is >= `version2`.
|
||||||
*
|
*
|
||||||
* @param version First version
|
* @param version First version
|
||||||
* @param version2 Second version
|
* @param version2 Second version
|
||||||
* @return true if `version` is >= `version2`
|
* @return true if `version` is >= `version2`
|
||||||
*/
|
*/
|
||||||
public boolean checkVersion(int[] version, int... version2) {
|
public boolean checkVersion(int[] version, int... version2) {
|
||||||
return version[0] > version2[0] || version[0] == version2[0] && version[1] > version2[1]
|
return version[0] > version2[0] || version[0] == version2[0] && version[1] > version2[1]
|
||||||
|
@ -2027,7 +2027,7 @@ import java.util.zip.ZipInputStream;
|
||||||
*
|
*
|
||||||
* @param alias to search plots
|
* @param alias to search plots
|
||||||
* @param worldname to filter alias to a specific world [optional] null means all worlds
|
* @param worldname to filter alias to a specific world [optional] null means all worlds
|
||||||
* @return Set<{ @ link Plot }> empty if nothing found
|
* @return Set<{@link Plot }> empty if nothing found
|
||||||
*/
|
*/
|
||||||
public Set<Plot> getPlotsByAlias(@Nullable final String alias,
|
public Set<Plot> getPlotsByAlias(@Nullable final String alias,
|
||||||
@NonNull final String worldname) {
|
@NonNull final String worldname) {
|
||||||
|
|
|
@ -37,8 +37,8 @@ import java.util.concurrent.CompletableFuture;
|
||||||
/**
|
/**
|
||||||
* SubCommand class
|
* SubCommand class
|
||||||
*
|
*
|
||||||
* @Deprecated In favor of normal Command class
|
* @deprecated In favor of normal Command class
|
||||||
* @see Command(Command, boolean)
|
* @see Command
|
||||||
*/
|
*/
|
||||||
public abstract class SubCommand extends Command {
|
public abstract class SubCommand extends Command {
|
||||||
public SubCommand() {
|
public SubCommand() {
|
||||||
|
|
|
@ -901,7 +901,7 @@ public class Plot {
|
||||||
* Clear a plot.
|
* Clear a plot.
|
||||||
*
|
*
|
||||||
* @param whenDone A runnable to execute when clearing finishes, or null
|
* @param whenDone A runnable to execute when clearing finishes, or null
|
||||||
* @see this#clear(boolean, boolean, Runnable)
|
* @see #clear(boolean, boolean, Runnable)
|
||||||
* @see #deletePlot(Runnable) to clear and delete a plot
|
* @see #deletePlot(Runnable) to clear and delete a plot
|
||||||
*/
|
*/
|
||||||
public void clear(Runnable whenDone) {
|
public void clear(Runnable whenDone) {
|
||||||
|
@ -1361,7 +1361,7 @@ public class Plot {
|
||||||
* Unlink a plot and remove the roads
|
* Unlink a plot and remove the roads
|
||||||
*
|
*
|
||||||
* @return true if plot was linked
|
* @return true if plot was linked
|
||||||
* @see this#unlinkPlot(boolean, boolean)
|
* @see #unlinkPlot(boolean, boolean)
|
||||||
*/
|
*/
|
||||||
public boolean unlink() {
|
public boolean unlink() {
|
||||||
return this.unlinkPlot(true, true);
|
return this.unlinkPlot(true, true);
|
||||||
|
@ -1525,8 +1525,6 @@ public class Plot {
|
||||||
/**
|
/**
|
||||||
* Gets the default home location for a plot<br>
|
* Gets the default home location for a plot<br>
|
||||||
* - Ignores any home location set for that specific plot
|
* - Ignores any home location set for that specific plot
|
||||||
*
|
|
||||||
* @return Location
|
|
||||||
*/
|
*/
|
||||||
public void getDefaultHome(Consumer<Location> result) {
|
public void getDefaultHome(Consumer<Location> result) {
|
||||||
getDefaultHome(false, result);
|
getDefaultHome(false, result);
|
||||||
|
@ -1871,8 +1869,6 @@ public class Plot {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve the biome of the plot.
|
* Retrieve the biome of the plot.
|
||||||
*
|
|
||||||
* @return the name of the biome
|
|
||||||
*/
|
*/
|
||||||
public void getBiome(Consumer<BiomeType> result) {
|
public void getBiome(Consumer<BiomeType> result) {
|
||||||
this.getCenter(location -> WorldUtil.IMP
|
this.getCenter(location -> WorldUtil.IMP
|
||||||
|
@ -2073,8 +2069,7 @@ public class Plot {
|
||||||
* @param whenDone A task to run when finished, or null
|
* @param whenDone A task to run when finished, or null
|
||||||
* @return boolean if swap was successful
|
* @return boolean if swap was successful
|
||||||
* @see ChunkManager#swap(Location, Location, Location, Location, Runnable) to swap terrain
|
* @see ChunkManager#swap(Location, Location, Location, Location, Runnable) to swap terrain
|
||||||
* @see this#swapData(Plot) to swap plot settings
|
* @see #swapData(Plot) to swap plot settings
|
||||||
* @see this#swapData(Plot)
|
|
||||||
*/
|
*/
|
||||||
public CompletableFuture<Boolean> swap(Plot destination, Runnable whenDone) {
|
public CompletableFuture<Boolean> swap(Plot destination, Runnable whenDone) {
|
||||||
return this.move(destination, whenDone, true);
|
return this.move(destination, whenDone, true);
|
||||||
|
@ -2194,8 +2189,6 @@ public class Plot {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Export the plot as a schematic to the configured output directory.
|
* Export the plot as a schematic to the configured output directory.
|
||||||
*
|
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
public void export(final RunnableVal<Boolean> whenDone) {
|
public void export(final RunnableVal<Boolean> whenDone) {
|
||||||
SchematicHandler.manager.getCompoundTag(this, new RunnableVal<CompoundTag>() {
|
SchematicHandler.manager.getCompoundTag(this, new RunnableVal<CompoundTag>() {
|
||||||
|
@ -3051,7 +3044,7 @@ public class Plot {
|
||||||
* Teleport a player to a plot and send them the teleport message.
|
* Teleport a player to a plot and send them the teleport message.
|
||||||
*
|
*
|
||||||
* @param player the player
|
* @param player the player
|
||||||
* @return if the teleport succeeded
|
* @param result Called with the result of the teleportation
|
||||||
*/
|
*/
|
||||||
public void teleportPlayer(final PlotPlayer player, Consumer<Boolean> result) {
|
public void teleportPlayer(final PlotPlayer player, Consumer<Boolean> result) {
|
||||||
teleportPlayer(player, TeleportCause.PLUGIN, result);
|
teleportPlayer(player, TeleportCause.PLUGIN, result);
|
||||||
|
@ -3062,7 +3055,7 @@ public class Plot {
|
||||||
*
|
*
|
||||||
* @param player the player
|
* @param player the player
|
||||||
* @param cause the cause of the teleport
|
* @param cause the cause of the teleport
|
||||||
* @return if the teleport succeeded
|
* @param resultConsumer Called with the result of the teleportation
|
||||||
*/
|
*/
|
||||||
public void teleportPlayer(final PlotPlayer player, TeleportCause cause,
|
public void teleportPlayer(final PlotPlayer player, TeleportCause cause,
|
||||||
Consumer<Boolean> resultConsumer) {
|
Consumer<Boolean> resultConsumer) {
|
||||||
|
|
|
@ -238,7 +238,7 @@ public abstract class PlotPlayer implements CommandCaller, OfflinePlotPlayer {
|
||||||
* Get the number of plots this player owns.
|
* Get the number of plots this player owns.
|
||||||
*
|
*
|
||||||
* @return number of plots within the scope (globally, or in the player's current world as defined in the settings.yml)
|
* @return number of plots within the scope (globally, or in the player's current world as defined in the settings.yml)
|
||||||
* @see #getPlotCount(String);
|
* @see #getPlotCount(String)
|
||||||
* @see #getPlots()
|
* @see #getPlots()
|
||||||
*/
|
*/
|
||||||
public int getPlotCount() {
|
public int getPlotCount() {
|
||||||
|
|
Loading…
Reference in a new issue