Upstream/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-21 11:45:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve javadoc linking

Browse Source
This commit is contained in:
NotMyFault 2021-08-24 15:34:21 +02:00
parent b2915d9bd7
commit 40e651188e
No known key found for this signature in database
GPG Key ID: 158F5701A6AAD00C
9 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Core/src/main/java/com/plotsquared/core/PlotAPI.java
View File

@ -187,7 +187,7 @@ public class PlotAPI {
* different UUIDs than Bukkit</i>
*
* @param uuid the uuid of the player to wrap
* @return a {@code PlotPlayer}
* @return a {@link PlotPlayer}
*/
public @Nullable PlotPlayer<?> wrapPlayer(final @NonNull UUID uuid) {
return PlotSquared.platform().playerManager().getPlayerIfExists(uuid);
@ -197,7 +197,7 @@ public class PlotAPI {
* Gets the PlotPlayer for a username.
*
* @param player the player to wrap
* @return a {@code PlotPlayer}
* @return a {@link PlotPlayer}
*/
public @Nullable PlotPlayer<?> wrapPlayer(final @NonNull String player) {
return PlotSquared.platform().playerManager().getPlayerIfExists(player);

4
Core/src/main/java/com/plotsquared/core/PlotSquared.java
View File

@ -339,7 +339,7 @@ public class PlotSquared {
/**
* Add a global reference to a plot world.
*
* @param plotArea the {@code PlotArea} to add.
* @param plotArea the {@link PlotArea} to add.
* @see #removePlotArea(PlotArea) To remove the reference
*/
public void addPlotArea(final @NonNull PlotArea plotArea) {
@ -429,7 +429,7 @@ public class PlotSquared {
/**
* Remove a plot world reference.
*
* @param area the {@code PlotArea} to remove
* @param area the {@link PlotArea} to remove
*/
public void removePlotArea(final @NonNull PlotArea area) {
getPlotAreaManager().removePlotArea(area);

4
Core/src/main/java/com/plotsquared/core/database/AbstractDB.java
View File

@ -127,7 +127,7 @@ public interface AbstractDB {
* Gets the table entry ID.
*
* @param plot the plot
* @return {@code Integer} = Plot Entry Id
* @return {@link Integer} = Plot Entry Id
*/
int getId(Plot plot);
@ -215,7 +215,7 @@ public interface AbstractDB {
* Purges a whole world.
*
* @param area World in which the plots should be purged
* @param plotIds the {@code PlotId}s of {@code Plot}s to purge
* @param plotIds the {@link PlotId}s of {@link Plot}s to purge
*/
void purge(PlotArea area, Set<PlotId> plotIds);

2
Core/src/main/java/com/plotsquared/core/events/PlayerAutoPlotEvent.java
View File

@ -31,7 +31,7 @@ import com.plotsquared.core.plot.PlotArea;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* PlayerAutoPlotEvent returns null for {@code PlotEvent.getPlot()} as the event is fired before the plot is chosen.
* PlayerAutoPlotEvent returns null for {@link PlotEvent#getPlot()} as the event is fired before the plot is chosen.
*/
public class PlayerAutoPlotEvent extends PlotEvent implements CancellablePlotEvent {

4
Core/src/main/java/com/plotsquared/core/location/Location.java
View File

@ -286,7 +286,7 @@ public final class Location extends BlockLoc implements Comparable<Location> {
}
/**
* Check whether or not the location belongs to a plot area
* Check whether the location belongs to a plot area
*
* @return {@code true} if the location belongs to a plot area, else {@code false}
*/
@ -295,7 +295,7 @@ public final class Location extends BlockLoc implements Comparable<Location> {
}
/**
* Check whether or not the location belongs to a plot road
* Check whether the location belongs to a plot road
*
* @return {@code true} if the location belongs to a plot road, else {@code false}
*/

2
Core/src/main/java/com/plotsquared/core/permissions/PermissionHandler.java
View File

@ -70,7 +70,7 @@ public interface PermissionHandler {
@NonNull Set<PermissionHandlerCapability> getCapabilities();
/**
* Check whether or not the permission handler has a given capability
* Check whether the permission handler has a given capability
*
* @param capability Capability
* @return {@code true} if the handler has the capability, else {@code false}

4
Core/src/main/java/com/plotsquared/core/player/PlotPlayer.java
View File

@ -374,9 +374,9 @@ public abstract class PlotPlayer<P> implements CommandCaller, OfflinePlotPlayer,
}
/**
* Get a {@code Set} of plots owned by this player.
* Get a {@link Set} of plots owned by this player.
*
* @return a {@code Set} of plots owned by the player
* @return a {@link Set} of plots owned by the player
* @see PlotSquared for more searching functions
* @see #getPlotCount() for the number of plots
*/

14
Core/src/main/java/com/plotsquared/core/plot/PlotArea.java
View File

@ -291,9 +291,9 @@ public abstract class PlotArea {
}
/**
* Check if a PlotArea is compatible (move/copy etc).
* Check if a PlotArea is compatible (move/copy etc.).
*
* @param plotArea the {@code PlotArea} to compare
* @param plotArea the {@link PlotArea} to compare
* @return true if both areas are compatible
*/
public boolean isCompatible(final @NonNull PlotArea plotArea) {
@ -578,10 +578,10 @@ public abstract class PlotArea {
public abstract ConfigurationNode[] getSettingNodes();
/**
* Gets the {@code Plot} at a location.
* Gets the {@link Plot} at a location.
*
* @param location the location
* @return the {@code Plot} or null if none exists
* @return the {@link Plot} or null if none exists
*/
public @Nullable Plot getPlotAbs(final @NonNull Location location) {
final PlotId pid =
@ -641,7 +641,7 @@ public abstract class PlotArea {
/**
* Get the owned Plot at a PlotId.
*
* @param id the {@code PlotId}
* @param id the {@link PlotId}
* @return the plot or null
*/
public @Nullable Plot getOwnedPlotAbs(final @NonNull PlotId id) {
@ -686,7 +686,7 @@ public abstract class PlotArea {
}
/**
* A collection of the claimed plots in this {@code PlotArea}.
* A collection of the claimed plots in this {@link PlotArea}.
*
* @return a collection of claimed plots
*/
@ -748,7 +748,7 @@ public abstract class PlotArea {
}
/**
* Retrieves the number of claimed plot in the {@code PlotArea}.
* Retrieves the number of claimed plot in the {@link PlotArea}.
*
* @return the number of claimed plots
*/

2
Core/src/main/java/com/plotsquared/core/util/WorldUtil.java
View File

@ -359,7 +359,7 @@ public abstract class WorldUtil {
*
* @param block1 First block
* @param block2 Second block
* @return {@code true} if the blocks have the same type, {@code false} if not
* @return {@code true} if the blocks have the same type, {@code false} if not
*/
public abstract boolean isBlockSame(@NonNull BlockState block1, @NonNull BlockState block2);