diff --git a/chat/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java b/chat/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java index 121a32c45..2ca59f754 100644 --- a/chat/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java +++ b/chat/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java @@ -116,9 +116,9 @@ public final class ComponentBuilder * * @param pos the cursor position synonymous to an element position for a * list + * @return this ComponentBuilder for chaining * @throws IndexOutOfBoundsException if the index is out of range * ({@code index < 0 || index >= size()}) - * @return this ComponentBuilder for chaining */ public ComponentBuilder setCursor(int pos) throws IndexOutOfBoundsException { diff --git a/chat/src/main/java/net/md_5/bungee/api/chat/TranslatableComponent.java b/chat/src/main/java/net/md_5/bungee/api/chat/TranslatableComponent.java index 285f1cfea..5c268d197 100644 --- a/chat/src/main/java/net/md_5/bungee/api/chat/TranslatableComponent.java +++ b/chat/src/main/java/net/md_5/bungee/api/chat/TranslatableComponent.java @@ -55,12 +55,12 @@ public final class TranslatableComponent extends BaseComponent /** * Creates a translatable component with the passed substitutions * - * @see #translate - * @see #setWith(java.util.List) * @param translate the translation key * @param with the {@link java.lang.String}s and * {@link net.md_5.bungee.api.chat.BaseComponent}s to use into the * translation + * @see #translate + * @see #setWith(java.util.List) */ public TranslatableComponent(String translate, Object... with) { diff --git a/checkstyle.xml b/checkstyle.xml index 58ed8a1de..afddb470f 100644 --- a/checkstyle.xml +++ b/checkstyle.xml @@ -21,6 +21,16 @@ + + + + + + + + + + diff --git a/event/src/main/java/net/md_5/bungee/event/EventBus.java b/event/src/main/java/net/md_5/bungee/event/EventBus.java index 5b5d42010..f5bd1f980 100644 --- a/event/src/main/java/net/md_5/bungee/event/EventBus.java +++ b/event/src/main/java/net/md_5/bungee/event/EventBus.java @@ -166,6 +166,8 @@ public class EventBus * Shouldn't be called without first locking the writeLock; intended for use * only inside {@link #register(java.lang.Object) register(Object)} or * {@link #unregister(java.lang.Object) unregister(Object)}. + * + * @param eventClass event class */ private void bakeHandlers(Class eventClass) { diff --git a/native/src/test/java/net/md_5/bungee/NativeCipherTest.java b/native/src/test/java/net/md_5/bungee/NativeCipherTest.java index c26da0001..72b81ab87 100644 --- a/native/src/test/java/net/md_5/bungee/NativeCipherTest.java +++ b/native/src/test/java/net/md_5/bungee/NativeCipherTest.java @@ -80,6 +80,9 @@ public class NativeCipherTest /** * Hackish test which can test both native and fallback ciphers using direct * buffers. + * + * @param cipher cipher to test + * @throws java.lang.Exception any exceptions encountered */ public void testACipher(BungeeCipher cipher) throws Exception { diff --git a/proxy/src/main/java/net/md_5/bungee/Metrics.java b/proxy/src/main/java/net/md_5/bungee/Metrics.java index 4fd3dd78e..eabf75736 100644 --- a/proxy/src/main/java/net/md_5/bungee/Metrics.java +++ b/proxy/src/main/java/net/md_5/bungee/Metrics.java @@ -52,7 +52,10 @@ public class Metrics extends TimerTask } /** - * Generic method that posts a plugin to the metrics website + * Generic method that posts a plugin to the metrics website. + * + * @param isPing first post or not + * @throws IOException any errors encountered */ private void postPlugin(boolean isPing) throws IOException { @@ -110,6 +113,7 @@ public class Metrics extends TimerTask * @param buffer the StringBuilder to append the data pair onto * @param key the key value * @param value the value + * @throws UnsupportedEncodingException if UTF-8 encoding not supported */ private static void encodeDataPair(final StringBuilder buffer, final String key, final String value) throws UnsupportedEncodingException { @@ -121,6 +125,7 @@ public class Metrics extends TimerTask * * @param text the text to encode * @return the encoded text, as UTF-8 + * @throws UnsupportedEncodingException if UTF-8 encoding not supported */ private static String encode(final String text) throws UnsupportedEncodingException { diff --git a/proxy/src/main/java/net/md_5/bungee/forge/ForgeClientHandler.java b/proxy/src/main/java/net/md_5/bungee/forge/ForgeClientHandler.java index 0d683856a..d15044f40 100644 --- a/proxy/src/main/java/net/md_5/bungee/forge/ForgeClientHandler.java +++ b/proxy/src/main/java/net/md_5/bungee/forge/ForgeClientHandler.java @@ -49,6 +49,7 @@ public class ForgeClientHandler * Handles the Forge packet. * * @param message The Forge Handshake packet to handle. + * @throws IllegalArgumentException if invalid packet received */ public void handle(PluginMessage message) throws IllegalArgumentException { @@ -79,6 +80,7 @@ public class ForgeClientHandler * Receives a {@link PluginMessage} from ForgeServer to pass to Client. * * @param message The message to being received. + * @throws IllegalArgumentException if invalid packet received */ public void receive(PluginMessage message) throws IllegalArgumentException { diff --git a/proxy/src/main/java/net/md_5/bungee/forge/ForgeServerHandler.java b/proxy/src/main/java/net/md_5/bungee/forge/ForgeServerHandler.java index 7166d0615..77d18e6d8 100644 --- a/proxy/src/main/java/net/md_5/bungee/forge/ForgeServerHandler.java +++ b/proxy/src/main/java/net/md_5/bungee/forge/ForgeServerHandler.java @@ -67,6 +67,7 @@ public class ForgeServerHandler * Receives a {@link PluginMessage} from ForgeClientData to pass to Server. * * @param message The message to being received. + * @throws IllegalArgumentException if invalid packet received */ public void receive(PluginMessage message) throws IllegalArgumentException {