Upstream/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-12-23 16:48:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix javadoc generation issues

Browse Source
This commit is contained in:
Alexander Söderberg 2020-04-11 03:23:48 +02:00
parent 6c1caac731
commit 5a6dbfda36
7 changed files with 16 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/Configuration.java
View File

@ -54,7 +54,7 @@ public interface Configuration extends ConfigurationSection {
* collection, then a new {@link MemoryConfiguration} will be created to
* hold the new default values.</p>
*
* @param defaults A map of Path->Values to add to defaults.
* @param defaults A map of Path-&gt;Values to add to defaults.
* @throws IllegalArgumentException Thrown if defaults is null.
*/
void addDefaults(Map<String, Object> defaults);

2
Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/file/FileConfiguration.java
View File

@ -170,7 +170,7 @@ public abstract class FileConfiguration extends MemoryConfiguration {
* Compiles the header for this FileConfiguration and returns the
* result.
*
* <p>This will use the header from {@link #options()} -> {@link
* <p>This will use the header from {@link #options()} -&gt; {@link
* FileConfigurationOptions#header()}, respecting the rules of {@link
* FileConfigurationOptions#copyHeader()} if set.
*

6
Core/src/main/java/com/github/intellectualsites/plotsquared/configuration/serialization/ConfigurationSerializable.java
View File

@ -33,11 +33,11 @@ import java.util.Map;
* the methods as defined by this interface:
* <ul>
* <li>A static method "deserialize" that accepts a single {@link Map}&lt;
* {@link String}, {@link Object}> and returns the class.</li>
* {@link String}, {@link Object}&gt; and returns the class.</li>
* <li>A static method "valueOf" that accepts a single {@link Map}&lt;{@link
* String}, {@link Object}> and returns the class.</li>
* String}, {@link Object}&gt; and returns the class.</li>
* <li>A constructor that accepts a single {@link Map}&lt;{@link String},
* {@link Object}>.</li>
* {@link Object}&gt;.</li>
* </ul>
* In addition to implementing this interface, you must register the class
* with {@link ConfigurationSerialization#registerClass(Class)}.

6
Core/src/main/java/com/github/intellectualsites/plotsquared/plot/PlotSquared.java
View File

@ -398,11 +398,11 @@ import java.util.zip.ZipInputStream;
}
/**
* Check if `version` is >= `version2`.
* Check if `version` is &gt;= `version2`.
*
* @param version First version
* @param version2 Second version
* @return true if `version` is >= `version2`
* @return true if `version` is &gt;= `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&lt;{@link Plot }&gt; empty if nothing found
*/
public Set<Plot> getPlotsByAlias(@Nullable final String alias,
@NonNull final String worldname) {

4
Core/src/main/java/com/github/intellectualsites/plotsquared/plot/commands/SubCommand.java
View File

@ -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() {

17
Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/Plot.java
View File

@ -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<br>
* - Ignores any home location set for that specific plot
*
* @return Location
*/
public void getDefaultHome(Consumer<Location> 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<BiomeType> 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<Boolean> 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<Boolean> whenDone) {
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.
*
* @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) {
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<Boolean> resultConsumer) {

2
Core/src/main/java/com/github/intellectualsites/plotsquared/plot/object/PlotPlayer.java
View File

@ -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() {