From 5a6dbfda36d535f44731cdcfcc8b09fded585af4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20S=C3=B6derberg?= Date: Sat, 11 Apr 2020 03:23:48 +0200 Subject: [PATCH] Fix javadoc generation issues --- .../configuration/Configuration.java | 2 +- .../configuration/file/FileConfiguration.java | 2 +- .../ConfigurationSerializable.java | 6 +++--- .../plotsquared/plot/PlotSquared.java | 6 +++--- .../plotsquared/plot/commands/SubCommand.java | 4 ++-- .../plotsquared/plot/object/Plot.java | 17 +++++------------ .../plotsquared/plot/object/PlotPlayer.java | 2 +- 7 files changed, 16 insertions(+), 23 deletions(-) diff --git a/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/Configuration.java b/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/Configuration.java index 9a76b9f1c..437a860a2 100644 --- a/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/Configuration.java +++ b/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/Configuration.java @@ -54,7 +54,7 @@ public interface Configuration extends ConfigurationSection { * collection, then a new {@link MemoryConfiguration} will be created to * hold the new default values.

* - * @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. */ void addDefaults(Map defaults); diff --git a/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/file/FileConfiguration.java b/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/file/FileConfiguration.java index 49f2858c9..a46b10ced 100644 --- a/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/file/FileConfiguration.java +++ b/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/file/FileConfiguration.java @@ -170,7 +170,7 @@ public abstract class FileConfiguration extends MemoryConfiguration { * Compiles the header for this FileConfiguration and returns the * result. * - *

This will use the header from {@link #options()} -> {@link + *

This will use the header from {@link #options()} -> {@link * FileConfigurationOptions#header()}, respecting the rules of {@link * FileConfigurationOptions#copyHeader()} if set. * diff --git a/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/serialization/ConfigurationSerializable.java b/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/serialization/ConfigurationSerializable.java index 022096f5e..63f5552e9 100644 --- a/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/serialization/ConfigurationSerializable.java +++ b/Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/serialization/ConfigurationSerializable.java @@ -33,11 +33,11 @@ import java.util.Map; * the methods as defined by this interface: *

* In addition to implementing this interface, you must register the class * with {@link ConfigurationSerialization#registerClass(Class)}. diff --git a/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/PlotSquared.java b/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/PlotSquared.java index c56a97bfd..e2e18b572 100644 --- a/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/PlotSquared.java +++ b/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/PlotSquared.java @@ -398,11 +398,11 @@ import java.util.zip.ZipInputStream; } /** - * Check if `version` is >= `version2`. + * Check if `version` is >= `version2`. * * @param version First version * @param version2 Second version - * @return true if `version` is >= `version2` + * @return true if `version` is >= `version2` */ public boolean checkVersion(int[] version, int... version2) { 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 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 getPlotsByAlias(@Nullable final String alias, @NonNull final String worldname) { diff --git a/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/commands/SubCommand.java b/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/commands/SubCommand.java index 02e68282d..ac99a3d24 100644 --- a/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/commands/SubCommand.java +++ b/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/commands/SubCommand.java @@ -37,8 +37,8 @@ import java.util.concurrent.CompletableFuture; /** * SubCommand class * - * @Deprecated In favor of normal Command class - * @see Command(Command, boolean) + * @deprecated In favor of normal Command class + * @see Command */ public abstract class SubCommand extends Command { public SubCommand() { diff --git a/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/Plot.java b/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/Plot.java index 6dd77a6ae..8467ef0b2 100644 --- a/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/Plot.java +++ b/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/Plot.java @@ -901,7 +901,7 @@ public class Plot { * Clear a plot. * * @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 */ public void clear(Runnable whenDone) { @@ -1361,7 +1361,7 @@ public class Plot { * Unlink a plot and remove the roads * * @return true if plot was linked - * @see this#unlinkPlot(boolean, boolean) + * @see #unlinkPlot(boolean, boolean) */ public boolean unlink() { return this.unlinkPlot(true, true); @@ -1525,8 +1525,6 @@ public class Plot { /** * Gets the default home location for a plot
* - Ignores any home location set for that specific plot - * - * @return Location */ public void getDefaultHome(Consumer result) { getDefaultHome(false, result); @@ -1871,8 +1869,6 @@ public class Plot { /** * Retrieve the biome of the plot. - * - * @return the name of the biome */ public void getBiome(Consumer result) { this.getCenter(location -> WorldUtil.IMP @@ -2073,8 +2069,7 @@ public class Plot { * @param whenDone A task to run when finished, or null * @return boolean if swap was successful * @see ChunkManager#swap(Location, Location, Location, Location, Runnable) to swap terrain - * @see this#swapData(Plot) to swap plot settings - * @see this#swapData(Plot) + * @see #swapData(Plot) to swap plot settings */ public CompletableFuture swap(Plot destination, Runnable whenDone) { return this.move(destination, whenDone, true); @@ -2194,8 +2189,6 @@ public class Plot { /** * Export the plot as a schematic to the configured output directory. - * - * @return */ public void export(final RunnableVal whenDone) { SchematicHandler.manager.getCompoundTag(this, new RunnableVal() { @@ -3051,7 +3044,7 @@ public class Plot { * Teleport a player to a plot and send them the teleport message. * * @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 result) { teleportPlayer(player, TeleportCause.PLUGIN, result); @@ -3062,7 +3055,7 @@ public class Plot { * * @param player the player * @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, Consumer resultConsumer) { diff --git a/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/PlotPlayer.java b/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/PlotPlayer.java index 9ee1e2770..9f2f27f0e 100644 --- a/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/PlotPlayer.java +++ b/Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/PlotPlayer.java @@ -238,7 +238,7 @@ public abstract class PlotPlayer implements CommandCaller, OfflinePlotPlayer { * 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) - * @see #getPlotCount(String); + * @see #getPlotCount(String) * @see #getPlots() */ public int getPlotCount() {