Cleanup javadoc warnings

This commit is contained in:
Shane Freeder
2018-08-16 12:20:58 +01:00
parent 609d6bba6a
commit 69928187c9
20 changed files with 203 additions and 62 deletions

View File

@@ -9,7 +9,7 @@ Allows you to do dynamic whitelisting and change of kick message
diff --git a/src/main/java/com/destroystokyo/paper/event/profile/ProfileWhitelistVerifyEvent.java b/src/main/java/com/destroystokyo/paper/event/profile/ProfileWhitelistVerifyEvent.java
new file mode 100644
index 00000000..662e79e3
index 000000000..199daf2b3
--- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/profile/ProfileWhitelistVerifyEvent.java
@@ -0,0 +0,0 @@
@@ -67,7 +67,7 @@ index 00000000..662e79e3
+ }
+
+ /**
+ * Gets the currently planned message to send to the user if they are not whitelisted
+ * @return the currently planned message to send to the user if they are not whitelisted
+ */
+ public String getKickMessage() {
+ return kickMessage;
@@ -81,7 +81,7 @@ index 00000000..662e79e3
+ }
+
+ /**
+ * The gameprofile of the player trying to connect
+ * @return the gameprofile of the player trying to connect
+ * @deprecated Will be removed in 1.13, use #{@link #getPlayerProfile()}
+ */
+ @Deprecated
@@ -97,7 +97,7 @@ index 00000000..662e79e3
+ }
+
+ /**
+ * Whether the player is whitelisted to play on this server (whitelist may be off is why its true)
+ * @return Whether the player is whitelisted to play on this server (whitelist may be off is why its true)
+ */
+ public boolean isWhitelisted() {
+ return whitelisted;
@@ -105,20 +105,21 @@ index 00000000..662e79e3
+
+ /**
+ * Changes the players whitelisted state. false will deny the login
+ * @param whitelisted The new whitelisted state
+ */
+ public void setWhitelisted(boolean whitelisted) {
+ this.whitelisted = whitelisted;
+ }
+
+ /**
+ * Returns if the player obtained whitelist status by having op
+ * @return if the player obtained whitelist status by having op
+ */
+ public boolean isOp() {
+ return isOp;
+ }
+
+ /**
+ * Returns if the server even has whitelist on
+ * @return if the server even has whitelist on
+ */
+ public boolean isWhitelistEnabled() {
+ return whitelistEnabled;