feat(docs): Improved javadocs documentation

This commit is contained in:
Adrian 2023-12-18 22:09:19 -05:00
parent 44eace9e42
commit 0a385ef6fb
No known key found for this signature in database
GPG Key ID: FB8EF84DCE1BE452
7 changed files with 23 additions and 5 deletions

View File

@ -17,6 +17,7 @@
package io.github._4drian3d.authmevelocity.api.paper.event; package io.github._4drian3d.authmevelocity.api.paper.event;
import org.bukkit.Bukkit;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList; import org.bukkit.event.HandlerList;
import org.bukkit.event.player.PlayerEvent; import org.bukkit.event.player.PlayerEvent;
@ -36,7 +37,7 @@ public final class LoginByProxyEvent extends PlayerEvent {
* @param who the player to be logged in * @param who the player to be logged in
*/ */
public LoginByProxyEvent(@NotNull Player who) { public LoginByProxyEvent(@NotNull Player who) {
super(who); super(who, !Bukkit.isPrimaryThread());
} }
@Override @Override

View File

@ -67,6 +67,10 @@ public final class PreSendOnLoginEvent implements ResultedEvent<ServerResult> {
return this.actualServer; return this.actualServer;
} }
/**
* Obtain the result of the event
* @return the event server result
*/
@Override @Override
public @NotNull ServerResult getResult() { public @NotNull ServerResult getResult() {
return this.result; return this.result;

View File

@ -20,5 +20,8 @@ package io.github._4drian3d.authmevelocity.api.velocity.event;
import com.velocitypowered.api.proxy.Player; import com.velocitypowered.api.proxy.Player;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
/**Event executed in case a player is forced unregister by a server operator*/ /**
* Event executed in case a player is forced unregister by a server operator
* @param player the player who has been forced unregister
* */
public record ProxyForcedUnregisterEvent(@Nullable Player player) {} public record ProxyForcedUnregisterEvent(@Nullable Player player) {}

View File

@ -22,5 +22,6 @@ import org.jetbrains.annotations.NotNull;
/** /**
* Event executed in case the player is successfully logged in * Event executed in case the player is successfully logged in
* @param player the player who has logged in
*/ */
public record ProxyLoginEvent(@NotNull Player player) {} public record ProxyLoginEvent(@NotNull Player player) {}

View File

@ -20,5 +20,8 @@ package io.github._4drian3d.authmevelocity.api.velocity.event;
import com.velocitypowered.api.proxy.Player; import com.velocitypowered.api.proxy.Player;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
/**Event executed in case the player has logout from the network */ /**
* Event executed in case the player has logout from the network
* @param player the player who has logged out
* */
public record ProxyLogoutEvent(@NotNull Player player) {} public record ProxyLogoutEvent(@NotNull Player player) {}

View File

@ -20,5 +20,8 @@ package io.github._4drian3d.authmevelocity.api.velocity.event;
import com.velocitypowered.api.proxy.Player; import com.velocitypowered.api.proxy.Player;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
/**Event executed in case the player has register itself*/ /**
* Event executed in case the player has register itself
* @param player the player registered
* */
public record ProxyRegisterEvent(@NotNull Player player) {} public record ProxyRegisterEvent(@NotNull Player player) {}

View File

@ -20,5 +20,8 @@ package io.github._4drian3d.authmevelocity.api.velocity.event;
import com.velocitypowered.api.proxy.Player; import com.velocitypowered.api.proxy.Player;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
/**Event executed in case the player has unregistered itself*/ /**
* Event executed in case the player has unregistered itself
* @param player the player who has unregistered itself
* */
public record ProxyUnregisterEvent(@NotNull Player player) {} public record ProxyUnregisterEvent(@NotNull Player player) {}