From 2cf1f22b13feaad0da08ca897116c16680929e3d Mon Sep 17 00:00:00 2001 From: Gabriele C Date: Fri, 7 Jul 2017 20:50:17 +0200 Subject: [PATCH] Fix javadocs --- .../fr/xephi/authme/events/AbstractUnregisterEvent.java | 1 + src/main/java/fr/xephi/authme/events/FailedLoginEvent.java | 1 + .../fr/xephi/authme/events/UnregisterByPlayerEvent.java | 1 + src/main/java/fr/xephi/authme/listener/OnJoinVerifier.java | 6 ++++++ src/main/java/fr/xephi/authme/mail/SendMailSsl.java | 1 + 5 files changed, 10 insertions(+) diff --git a/src/main/java/fr/xephi/authme/events/AbstractUnregisterEvent.java b/src/main/java/fr/xephi/authme/events/AbstractUnregisterEvent.java index 1ab96689e..ac07b2ced 100644 --- a/src/main/java/fr/xephi/authme/events/AbstractUnregisterEvent.java +++ b/src/main/java/fr/xephi/authme/events/AbstractUnregisterEvent.java @@ -13,6 +13,7 @@ public abstract class AbstractUnregisterEvent extends CustomEvent { * Constructor for a player that has unregistered himself. * * @param player the player + * @param isAsync if the event is called asynchronously */ public AbstractUnregisterEvent(Player player, boolean isAsync) { super(isAsync); diff --git a/src/main/java/fr/xephi/authme/events/FailedLoginEvent.java b/src/main/java/fr/xephi/authme/events/FailedLoginEvent.java index 3a1e2d0d8..c80ce65b8 100644 --- a/src/main/java/fr/xephi/authme/events/FailedLoginEvent.java +++ b/src/main/java/fr/xephi/authme/events/FailedLoginEvent.java @@ -16,6 +16,7 @@ public class FailedLoginEvent extends CustomEvent { * Constructor. * * @param player The player + * @param isAsync if the event is called asynchronously */ public FailedLoginEvent(Player player, boolean isAsync) { super(isAsync); diff --git a/src/main/java/fr/xephi/authme/events/UnregisterByPlayerEvent.java b/src/main/java/fr/xephi/authme/events/UnregisterByPlayerEvent.java index bd28c50ee..cd96cd91d 100644 --- a/src/main/java/fr/xephi/authme/events/UnregisterByPlayerEvent.java +++ b/src/main/java/fr/xephi/authme/events/UnregisterByPlayerEvent.java @@ -14,6 +14,7 @@ public class UnregisterByPlayerEvent extends AbstractUnregisterEvent { * Constructor. * * @param player the player (never null) + * @param isAsync if the event is called asynchronously */ public UnregisterByPlayerEvent(Player player, boolean isAsync) { super(player, isAsync); diff --git a/src/main/java/fr/xephi/authme/listener/OnJoinVerifier.java b/src/main/java/fr/xephi/authme/listener/OnJoinVerifier.java index c7644e083..78262d98c 100644 --- a/src/main/java/fr/xephi/authme/listener/OnJoinVerifier.java +++ b/src/main/java/fr/xephi/authme/listener/OnJoinVerifier.java @@ -66,6 +66,7 @@ public class OnJoinVerifier implements Reloadable { * * @param player the player * @param isAuthAvailable whether or not the player is registered + * @throws FailedVerificationException if the verification fails */ public void checkAntibot(Player player, boolean isAuthAvailable) throws FailedVerificationException { if (isAuthAvailable || permissionsManager.hasPermission(player, PlayerStatePermission.BYPASS_ANTIBOT)) { @@ -81,6 +82,7 @@ public class OnJoinVerifier implements Reloadable { * Checks whether non-registered players should be kicked, and if so, whether the player should be kicked. * * @param isAuthAvailable whether or not the player is registered + * @throws FailedVerificationException if the verification fails */ public void checkKickNonRegistered(boolean isAuthAvailable) throws FailedVerificationException { if (!isAuthAvailable && settings.getProperty(RestrictionSettings.KICK_NON_REGISTERED)) { @@ -92,6 +94,7 @@ public class OnJoinVerifier implements Reloadable { * Checks that the name adheres to the configured username restrictions. * * @param name the name to verify + * @throws FailedVerificationException if the verification fails */ public void checkIsValidName(String name) throws FailedVerificationException { if (name.length() > settings.getProperty(RestrictionSettings.MAX_NICKNAME_LENGTH) @@ -147,6 +150,7 @@ public class OnJoinVerifier implements Reloadable { * * @param player the player to verify * @param auth the auth object associated with the player + * @throws FailedVerificationException if the verification fails */ public void checkNameCasing(Player player, PlayerAuth auth) throws FailedVerificationException { if (auth != null && settings.getProperty(RegistrationSettings.PREVENT_OTHER_CASE)) { @@ -166,6 +170,7 @@ public class OnJoinVerifier implements Reloadable { * * @param isAuthAvailable whether or not the user is registered * @param playerIp the ip address of the player + * @throws FailedVerificationException if the verification fails */ public void checkPlayerCountry(boolean isAuthAvailable, String playerIp) throws FailedVerificationException { @@ -181,6 +186,7 @@ public class OnJoinVerifier implements Reloadable { * connection if so configured. * * @param name the player name to check + * @throws FailedVerificationException if the verification fails */ public void checkSingleSession(String name) throws FailedVerificationException { if (!settings.getProperty(RestrictionSettings.FORCE_SINGLE_SESSION)) { diff --git a/src/main/java/fr/xephi/authme/mail/SendMailSsl.java b/src/main/java/fr/xephi/authme/mail/SendMailSsl.java index 885f81985..6dff833ff 100644 --- a/src/main/java/fr/xephi/authme/mail/SendMailSsl.java +++ b/src/main/java/fr/xephi/authme/mail/SendMailSsl.java @@ -45,6 +45,7 @@ public class SendMailSsl { * * @param emailAddress the email address the email is destined for * @return the created HtmlEmail object + * @throws EmailException if the mail is invalid */ public HtmlEmail initializeMail(String emailAddress) throws EmailException { String senderMail = StringUtils.isEmpty(settings.getProperty(EmailSettings.MAIL_ADDRESS))