Makes some small comment adjustments

This commit is contained in:
Kristian Knarvik 2021-10-13 14:08:38 +02:00
parent f16a7089f4
commit 0ab6cb52c0
3 changed files with 12 additions and 7 deletions

View File

@ -4,7 +4,7 @@ import org.bukkit.Chunk;
import org.jetbrains.annotations.NotNull;
/**
* Requests the unloading of a chunk which has been previously loaded by the Stargate plugin
* Represents a requests for the unloading of a chunk which has been previously loaded by the Stargate plugin
*/
public class ChunkUnloadRequest implements Comparable<ChunkUnloadRequest> {
@ -33,7 +33,7 @@ public class ChunkUnloadRequest implements Comparable<ChunkUnloadRequest> {
}
/**
* Gets the time system nano time denoting at which time the unload request should be executed
* Gets the system nano time denoting at which time the unload request should be executed
*
* @return <p>The system nano time denoting when the chunk is to be unloaded</p>
*/
@ -48,6 +48,7 @@ public class ChunkUnloadRequest implements Comparable<ChunkUnloadRequest> {
@Override
public int compareTo(@NotNull ChunkUnloadRequest otherRequest) {
//Prioritize requests based on time until unload
return unloadNanoTime.compareTo(otherRequest.unloadNanoTime);
}

View File

@ -5,6 +5,10 @@ import org.bukkit.entity.Player;
/**
* This class represents a player teleporting from the end to the over-world using an artificial end portal
*
* <p>This is necessary because a player entering an end portal in the end is a special case. Instead of being
* teleported, the player is respawned. Because of this, the teleportation needs to be saved and later used to hijack
* the position of where the player is to respawn.</p>
*/
public class FromTheEndTeleportation {

View File

@ -32,8 +32,8 @@ public class RelativeBlockVector {
/**
* Adds a value to one of the properties of this relative block vector
*
* @param propertyToAddTo <p>The property to change</p>
* @param valueToAdd <p>The value to add to the property</p>
* @param propertyToAddTo <p>The property to add to</p>
* @param valueToAdd <p>The value to add to the property (negative to move in the opposite direction)</p>
* @return <p>A new relative block vector with the property altered</p>
*/
public RelativeBlockVector addToVector(Property propertyToAddTo, int valueToAdd) {
@ -61,7 +61,7 @@ public class RelativeBlockVector {
/**
* Gets the distance to the right relative to the origin
*
* @return The distance to the right relative to the origin
* @return <p>The distance to the right relative to the origin</p>
*/
public int getRight() {
return right;
@ -70,7 +70,7 @@ public class RelativeBlockVector {
/**
* Gets the distance downward relative to the origin
*
* @return The distance downward relative to the origin
* @return <p>The distance downward relative to the origin</p>
*/
public int getDepth() {
return depth;
@ -79,7 +79,7 @@ public class RelativeBlockVector {
/**
* Gets the distance outward relative to the origin
*
* @return The distance outward relative to the origin
* @return <p>The distance outward relative to the origin</p>
*/
public int getDistance() {
return distance;