Fix javadoc doclint issues

Also, bump javadoc plugin to 3.1.0, as this fixes some local issues with
the javadoc tool not being in the correct place, we're also going to
leave doclint disabled, upstream doesn't seem to care about this too
much, nor do I really feel a super strong need to maintain this.
This commit is contained in:
Shane Freeder 2019-03-30 16:09:06 +00:00
parent c331e7fd00
commit 083479278e
11 changed files with 225 additions and 46 deletions

View File

@ -1,4 +1,4 @@
From e13d5e03ba9dbb686937c214bce85a6bfabd860c Mon Sep 17 00:00:00 2001
From 28cd0114e469f193732903fc2e3beb23d3ac898b Mon Sep 17 00:00:00 2001
From: Tux <write@imaginarycode.com>
Date: Thu, 19 May 2016 19:33:31 +0200
Subject: [PATCH] POM Changes
@ -483,7 +483,7 @@ index 15c0ada2..7073b404 100644
<dependencies>
<dependency>
diff --git a/pom.xml b/pom.xml
index 6cd54c2d..daaf18b9 100644
index 6cd54c2d..c209363d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -3,18 +3,25 @@
@ -587,7 +587,7 @@ index 6cd54c2d..daaf18b9 100644
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
@@ -118,24 +142,13 @@
@@ -118,24 +142,12 @@
</execution>
</executions>
</plugin>
@ -606,18 +606,17 @@ index 6cd54c2d..daaf18b9 100644
- </executions>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.7</version>
+ <version>3.1.0</version>
<configuration>
- <signature>
- <groupId>org.codehaus.mojo.signature</groupId>
- <artifactId>java18</artifactId>
- <version>1.0</version>
- </signature>
+ <additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
</plugins>
@@ -171,4 +184,87 @@
@@ -171,4 +183,87 @@
</plugins>
</pluginManagement>
</build>
@ -648,9 +647,9 @@ index 6cd54c2d..daaf18b9 100644
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.7</version>
+ <version>3.1.0</version>
+ <configuration>
+ <additionalparam>-Xdoclint:none</additionalparam>
+ <!--<additionalparam>-Xdoclint:none</additionalparam>-->
+ </configuration>
+ <executions>
+ <execution>

View File

@ -1,14 +1,14 @@
From 992e57ffc568170937269a376a08ccba639f13ed Mon Sep 17 00:00:00 2001
From 97320acc36462cc8910f6d0da90409b14e0ebd2f Mon Sep 17 00:00:00 2001
From: Johannes Donath <johannesd@torchmind.com>
Date: Sat, 4 Jul 2015 06:31:33 +0200
Subject: [PATCH] Add basic support for configurable tab-complete throttling
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index b30541be..08d2a870 100644
index b30541be..79d8b683 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -84,4 +84,17 @@ public interface ProxyConfig
@@ -84,4 +84,21 @@ public interface ProxyConfig
// Waterfall Options
//
@ -16,12 +16,16 @@ index b30541be..08d2a870 100644
+
+ /**
+ * How often tab-complete packets can be sent.
+ * <p/>
+ * <br>
+ * Values in milliseconds.
+ *
+ * @return how often tab-complete packets can be sent in milliseconds
+ */
+ int getTabThrottle();
+
+ /**
+ * Should we disable the tab completion limit for 1.13+ clients
+ *
+ * @return should we disable the tab completion limit for 1.13+ clients
+ */
+ boolean isDisableModernTabLimiter();
@ -69,7 +73,7 @@ index 741ebfde..91743f01 100644
+ }
}
diff --git a/proxy/src/main/java/net/md_5/bungee/connection/UpstreamBridge.java b/proxy/src/main/java/net/md_5/bungee/connection/UpstreamBridge.java
index 83d7630e..54ccaa49 100644
index 540cf213..de916f6e 100644
--- a/proxy/src/main/java/net/md_5/bungee/connection/UpstreamBridge.java
+++ b/proxy/src/main/java/net/md_5/bungee/connection/UpstreamBridge.java
@@ -37,6 +37,8 @@ public class UpstreamBridge extends PacketHandler
@ -103,5 +107,5 @@ index 83d7630e..54ccaa49 100644
if ( tabComplete.getCursor().startsWith( "/" ) )
--
2.20.1
2.21.0

View File

@ -1,4 +1,4 @@
From 409714e4e17b097a97540fae759b0d955cb35f5a Mon Sep 17 00:00:00 2001
From e0ea7ec08b0d7306fa1a3f742f4b8899e60f5f63 Mon Sep 17 00:00:00 2001
From: Janmm14 <computerjanimaus@yahoo.de>
Date: Sat, 12 Dec 2015 23:43:30 +0100
Subject: [PATCH] Optional server list ping logging.
@ -9,15 +9,17 @@ This avoids spamming the logs with connection notices.
Server list pings are only logged if the log_server_list_pings config.yml option is true, defaults to false
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index 08d2a870..72f35bd6 100644
index 79d8b683..0d48c775 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -84,6 +84,11 @@ public interface ProxyConfig
@@ -84,6 +84,13 @@ public interface ProxyConfig
// Waterfall Options
//
+ /**
+ * Whether we log server list pings
+ *
+ * @return whether we log server list pings
+ */
+ boolean isLogServerListPing();
+
@ -130,5 +132,5 @@ index de916f6e..bdaee47e 100644
}
}
--
2.20.1
2.21.0

View File

@ -1,4 +1,4 @@
From c58af26b87c012573c2596456e5a22c3a982e677 Mon Sep 17 00:00:00 2001
From eeaf6ec7c4ce8b15447399baffe5b63675ea7358 Mon Sep 17 00:00:00 2001
From: Techcable <Techcable@techcable.net>
Date: Mon, 25 Apr 2016 23:46:00 -0700
Subject: [PATCH] Reduce the overhead of lots and lots of teams with the same
@ -11,7 +11,7 @@ Uses a sorted array to avoid the overhead of the hashset in a team.
diff --git a/api/src/main/java/io/github/waterfallmc/waterfall/utils/LowMemorySet.java b/api/src/main/java/io/github/waterfallmc/waterfall/utils/LowMemorySet.java
new file mode 100644
index 00000000..a1b6981e
index 00000000..6c006923
--- /dev/null
+++ b/api/src/main/java/io/github/waterfallmc/waterfall/utils/LowMemorySet.java
@@ -0,0 +1,151 @@
@ -31,7 +31,7 @@ index 00000000..a1b6981e
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * A set that uses a <a href=>binary search</a> to find objects in a <a href=https://en.wikipedia.org/wiki/Sorted_array>sorted array</a>.
+ * A set that uses a <a href=https://en.wikipedia.org/wiki/Binary_search_algorithm>binary search</a> to find objects in a <a href=https://en.wikipedia.org/wiki/Sorted_array>sorted array</a>.
+ * Avoids the memory cost of {@link java.util.HashSet}, while maintaining reasonable {@link Set#contains}
+ * <b>Insertions are O(N)!</b>
+ */
@ -267,5 +267,5 @@ index 00000000..5aa306a1
+
+}
--
2.19.1
2.21.0

View File

@ -1,4 +1,4 @@
From 2c75e17fb5b997014b548a5c9f6a8899c94c7453 Mon Sep 17 00:00:00 2001
From 1ccc9a25873be025895b669c8c3388bc7e05ada9 Mon Sep 17 00:00:00 2001
From: Troy Frew <fuzzy_bot@arenaga.me>
Date: Wed, 29 Jun 2016 04:29:25 +0200
Subject: [PATCH] Add dynamic server addition/removal api.
@ -8,10 +8,10 @@ The provided methods will not move a player if a server is removed or the server
Thanks to Overcast for the idea
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index 72f35bd6..78519227 100644
index 0d48c775..7f828010 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -32,9 +32,83 @@ public interface ProxyConfig
@@ -32,9 +32,95 @@ public interface ProxyConfig
/**
* Set of all servers.
@ -45,6 +45,8 @@ index 72f35bd6..78519227 100644
+ * Any currently registered server with the same name will be replaced.
+ * This change is not saved to config.yml
+ *
+ * @param server The server to register with the proxy
+ *
+ * @return the previously registered server with the same name, or null if there was no such server.
+ */
+ ServerInfo addServer(ServerInfo server);
@ -53,6 +55,8 @@ index 72f35bd6..78519227 100644
+ * Register all of the given servers to the proxy.
+ * This change is not saved to config.yml
+ *
+ * @param servers The collection of servers to register with the proxy
+ *
+ * @return true if any servers were added or replaced.
+ */
+ boolean addServers(Collection<ServerInfo> servers);
@ -61,6 +65,8 @@ index 72f35bd6..78519227 100644
+ * Un-register the server with the given name from the proxy.
+ * This change is not saved to config.yml
+ *
+ * @param name The name of the server to unregister
+ *
+ * @return the server that was removed, or null if there is no server with the given name.
+ */
+ ServerInfo removeServerNamed(String name);
@ -70,6 +76,8 @@ index 72f35bd6..78519227 100644
+ * The server is matched by name only, other fields in the given {@link ServerInfo} are ignored.
+ * This change is not saved to config.yml
+ *
+ * @param server the server to unregister from the proxy
+ *
+ * @return the server that was removed, or null if there is no server with a matching name.
+ */
+ ServerInfo removeServer(ServerInfo server);
@ -78,6 +86,8 @@ index 72f35bd6..78519227 100644
+ * Un-register servers with any of the given names from the proxy.
+ * This change is not saved to config.yml
+ *
+ * @param names a collection of server names to be unregistered
+ *
+ * @return true if any servers were removed.
+ */
+ boolean removeServersNamed(Collection<String> names);
@ -87,6 +97,8 @@ index 72f35bd6..78519227 100644
+ * The servers are matched by name only, other fields in the given {@link ServerInfo} are ignored.
+ * This change is not saved to config.yml
+ *
+ * @param servers a collection of servers to be unregistered
+ *
+ * @return true if any servers were removed.
+ */
+ boolean removeServers(Collection<ServerInfo> servers);

View File

@ -1,19 +1,21 @@
From b8ab554d593ed32ef31e012bf2e1a435c38f305f Mon Sep 17 00:00:00 2001
From 32cd939db6245ae0090b8268ebeb9b9c66125e7b Mon Sep 17 00:00:00 2001
From: Troy Frew <fuzzy_bot@arenaga.me>
Date: Wed, 29 Jun 2016 13:56:57 -0500
Subject: [PATCH] Configurable server version in ping response
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index 78519227..34d7e2cb 100644
index 7f828010..ed85dfc0 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -163,6 +163,11 @@ public interface ProxyConfig
@@ -177,6 +177,13 @@ public interface ProxyConfig
*/
boolean isLogServerListPing();
+ /**
+ * The supported versions
+ *
+ * @return the supported versions
+ */
+ String getGameVersion();
+
@ -81,5 +83,5 @@ index ef6d2028..00f8a19c 100644
@Override
--
2.20.1
2.21.0

View File

@ -1,4 +1,4 @@
From 1402d27067ec700f3a01ad7ceb1613e56d5e43cc Mon Sep 17 00:00:00 2001
From 4d4473a2e1176e6bf862252f1df7e9491072d80e Mon Sep 17 00:00:00 2001
From: Tux <write@imaginarycode.com>
Date: Wed, 21 Dec 2016 03:13:03 -0500
Subject: [PATCH] Optionally use async Netty DNS resolver
@ -6,15 +6,17 @@ Subject: [PATCH] Optionally use async Netty DNS resolver
We no longer need to cache the address for the session server now.
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index 34d7e2cb..47d4ab36 100644
index ed85dfc0..cf47e24a 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -168,6 +168,11 @@ public interface ProxyConfig
@@ -184,6 +184,13 @@ public interface ProxyConfig
*/
String getGameVersion();
+ /**
+ * Whether Netty's async DNS resolver is used for account authentication.
+ *
+ * @return whether Netty's async DNS resolver is used for account authentication.
+ */
+ boolean isUseNettyDnsResolver();
+
@ -181,5 +183,5 @@ index ba274eea..feea59d6 100644
return epoll ? EpollDatagramChannel.class : NioDatagramChannel.class;
}
--
2.20.1
2.21.0

View File

@ -1,25 +1,27 @@
From 7757dae81e5065844336d28a60919ca9806428fc Mon Sep 17 00:00:00 2001
From 892d03a7b8c7ac4e3bc442fe877c3aa5f9cf449d Mon Sep 17 00:00:00 2001
From: Gabriele C <sgdc3.mail@gmail.com>
Date: Thu, 8 Feb 2018 19:10:52 +0100
Subject: [PATCH] Optionally log InitialHandler connections
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index 47d4ab36..8680fd9b 100644
index cf47e24a..7220ca08 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -163,6 +163,11 @@ public interface ProxyConfig
@@ -177,6 +177,13 @@ public interface ProxyConfig
*/
boolean isLogServerListPing();
+ /**
+ * Whether we log InitialHandler connections
+ *
+ * @return whether we log InitialHandler connections
+ */
+ boolean isLogInitialHandlerConnections();
+
/**
* The supported versions
*/
*
diff --git a/proxy/src/main/java/io/github/waterfallmc/waterfall/conf/WaterfallConfiguration.java b/proxy/src/main/java/io/github/waterfallmc/waterfall/conf/WaterfallConfiguration.java
index b7e3dad0..d343e9b8 100644
--- a/proxy/src/main/java/io/github/waterfallmc/waterfall/conf/WaterfallConfiguration.java
@ -72,5 +74,5 @@ index b0b2994a..e81236fc 100644
bungee.getLogger().log( Level.INFO, "{0} has connected", this );
}
--
2.20.1
2.21.0

View File

@ -1,4 +1,4 @@
From a4251c9dab7b2441bb8893fc2ef9443225d9b50e Mon Sep 17 00:00:00 2001
From 0a67ac857dfea46c1a46ee5335d451add2c82340 Mon Sep 17 00:00:00 2001
From: Shane Freeder <theboyetronic@gmail.com>
Date: Fri, 12 Oct 2018 14:28:52 +0100
Subject: [PATCH] Add Configuration to allow empty packets
@ -11,14 +11,19 @@ provided as a last ditch effort for server owners to allow players
to connect in such a broken state as allowed by vanilla.
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index 8680fd9b..f792426e 100644
index 7220ca08..edc16a7d 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -191,4 +191,6 @@ public interface ProxyConfig
@@ -215,4 +215,11 @@ public interface ProxyConfig
* @return should we disable the tab completion limit for 1.13+ clients
*/
boolean isDisableModernTabLimiter();
+
+ /**
+ * Should we allow empty packets
+ *
+ * @return should we allow empty packets
+ */
+ boolean isAllowEmptyPackets();
}
diff --git a/protocol/src/main/java/net/md_5/bungee/protocol/Varint21FrameDecoder.java b/protocol/src/main/java/net/md_5/bungee/protocol/Varint21FrameDecoder.java

View File

@ -1,4 +1,4 @@
From f3291be33d3a2e2766ba43ce1da71dada0511a7a Mon Sep 17 00:00:00 2001
From fe4d850a54704e52323047ac9dc0248efe732242 Mon Sep 17 00:00:00 2001
From: Shane Freeder <theboyetronic@gmail.com>
Date: Mon, 14 Jan 2019 03:35:21 +0000
Subject: [PATCH] Provide an option to disable entity metadata rewriting
@ -12,12 +12,12 @@ may also create various issues with mods which do not support this,
hence why the configuration option is provided
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index f792426e..92070fcf 100644
index edc16a7d..4372f758 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -193,4 +193,9 @@ public interface ProxyConfig
boolean isDisableModernTabLimiter();
@@ -222,4 +222,9 @@ public interface ProxyConfig
* @return should we allow empty packets
*/
boolean isAllowEmptyPackets();
+
+ /**

View File

@ -0,0 +1,151 @@
From 8eaa9350d99477878bc934fadf0ead9d685ee577 Mon Sep 17 00:00:00 2001
From: Shane Freeder <theboyetronic@gmail.com>
Date: Sat, 30 Mar 2019 15:11:11 +0000
Subject: [PATCH] Fix upstream javadocs
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
index 4372f758..b39f3a98 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java
@@ -17,22 +17,27 @@ public interface ProxyConfig
/**
* Time before users are disconnected due to no network activity.
+ * @return the time before users are disconnected due to no network activity.
*/
int getTimeout();
/**
* UUID used for metrics.
+ * @return the UUID used for metrics
*/
String getUuid();
/**
* Set of all listeners.
+ * @return a set of all listeners
*/
Collection<ListenerInfo> getListeners();
/**
* Set of all servers.
*
+ * @return a map of registered servers
+ *
* @deprecated The returned map may be modified concurrently by the proxy.
* The safe alternative is {@link #getServersCopy()}.
*/
@@ -123,32 +128,44 @@ public interface ProxyConfig
/**
* Does the server authenticate with mojang
+ *
+ * @return if the server authenticates to mojang
*/
boolean isOnlineMode();
/**
* Whether proxy commands are logged to the proxy log
+ *
+ * @return should the proxy log commands
*/
boolean isLogCommands();
/**
* Returns the player max.
+ *
+ * @return the player limit
*/
int getPlayerLimit();
/**
* A collection of disabled commands.
+ *
+ * @return a collection of disabled commands
*/
Collection<String> getDisabledCommands();
/**
* The connection throttle delay.
+ *
+ * @return the connection throttle delay
*/
@Deprecated
int getThrottle();
/**
- * Whether the proxy will parse IPs with spigot or not
+ * Whether the proxy will forward the players information (UUID, IP)
+ *
+ * @return should we forward player information
*/
@Deprecated
boolean isIpForward();
@@ -156,6 +173,7 @@ public interface ProxyConfig
/**
* The encoded favicon.
*
+ * @return the encoded favicon
* @deprecated Use #getFaviconObject instead.
*/
@Deprecated
@@ -163,6 +181,8 @@ public interface ProxyConfig
/**
* The favicon used for the server ping list.
+ *
+ * @return the favicon used for the server ping list
*/
Favicon getFaviconObject();
diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyServer.java b/api/src/main/java/net/md_5/bungee/api/ProxyServer.java
index ccfefd26..4965b234 100644
--- a/api/src/main/java/net/md_5/bungee/api/ProxyServer.java
+++ b/api/src/main/java/net/md_5/bungee/api/ProxyServer.java
@@ -52,6 +52,9 @@ public abstract class ProxyServer
/**
* Gets a localized string from the .properties file.
*
+ * @param name the name of the translation
+ * @param args the arguments used for translation
+ *
* @return the localized string
*/
public abstract String getTranslation(String name, Object... args);
diff --git a/api/src/main/java/net/md_5/bungee/api/plugin/PluginManager.java b/api/src/main/java/net/md_5/bungee/api/plugin/PluginManager.java
index 9408e6c2..884f78c8 100644
--- a/api/src/main/java/net/md_5/bungee/api/plugin/PluginManager.java
+++ b/api/src/main/java/net/md_5/bungee/api/plugin/PluginManager.java
@@ -148,6 +148,7 @@ public class PluginManager
* @param sender the sender executing the command
* @param commandLine the complete command line including command name and
* arguments
+ * @param tabResults the List for tab results to be added to, or null if executing the command
* @return whether the command was handled
*/
public boolean dispatchCommand(CommandSender sender, String commandLine, List<String> tabResults)
@@ -475,6 +476,8 @@ public class PluginManager
/**
* Unregister all of a Plugin's listener.
+ *
+ * @param plugin the plugin to unregister listeners for
*/
public void unregisterListeners(Plugin plugin)
{
diff --git a/api/src/main/java/net/md_5/bungee/api/scheduler/TaskScheduler.java b/api/src/main/java/net/md_5/bungee/api/scheduler/TaskScheduler.java
index 5d2b088c..be32ba89 100644
--- a/api/src/main/java/net/md_5/bungee/api/scheduler/TaskScheduler.java
+++ b/api/src/main/java/net/md_5/bungee/api/scheduler/TaskScheduler.java
@@ -85,6 +85,7 @@ public interface TaskScheduler
/**
* An executor service which underlies this scheduler.
+ * @param plugin The plugin of which to fetch an executor service for
*
* @return the underlying executor service or compatible wrapper
*/
--
2.21.0