From 487e79c043fdaf50a40430390e941da73a96f4ad Mon Sep 17 00:00:00 2001 From: Myles Date: Thu, 26 May 2016 13:54:22 +0100 Subject: [PATCH] Fix javadocs --- .../myles/ViaVersion/api/PacketWrapper.java | 9 +++++- .../myles/ViaVersion/api/ViaVersionAPI.java | 2 +- .../ViaVersion/api/ViaVersionConfig.java | 4 +-- .../us/myles/ViaVersion/api/boss/BossBar.java | 30 +++++++++++++------ .../ViaVersion/api/command/ViaSubCommand.java | 10 +++---- .../ViaVersion/api/data/UserConnection.java | 7 +++-- .../api/minecraft/chunks/ChunkSection.java | 1 + .../api/remapper/PacketRemapper.java | 5 +++- 8 files changed, 47 insertions(+), 21 deletions(-) diff --git a/src/main/java/us/myles/ViaVersion/api/PacketWrapper.java b/src/main/java/us/myles/ViaVersion/api/PacketWrapper.java index aabf631ac..2e251fb89 100644 --- a/src/main/java/us/myles/ViaVersion/api/PacketWrapper.java +++ b/src/main/java/us/myles/ViaVersion/api/PacketWrapper.java @@ -38,8 +38,10 @@ public class PacketWrapper { * Get a part from the output * * @param type The type of the part you wish to get. + * @param The return type of the type you wish to get. * @param index The index of the part (relative to the type) * @return The requested type or throws ArrayIndexOutOfBounds + * @throws Exception If it fails to find it, an exception will be thrown. */ public T get(Type type, int index) throws Exception { int currentIndex = 0; @@ -80,8 +82,10 @@ public class PacketWrapper { * Set a currently existing part in the output * * @param type The type of the part you wish to set. + * @param The return type of the type you wish to set. * @param index The index of the part (relative to the type) * @param value The value of the part you wish to set it to. + * @throws Exception If it fails to set it, an exception will be thrown. */ public void set(Type type, int index, T value) throws Exception { int currentIndex = 0; @@ -102,6 +106,7 @@ public class PacketWrapper { * Read a type from the input. * * @param type The type you wish to read + * @param The return type of the type you wish to read. * @return The requested type * @throws Exception If it fails to read */ @@ -134,6 +139,7 @@ public class PacketWrapper { * Write a type to the output. * * @param type The type to write. + * @param The return type of the type you wish to write. * @param value The value of the type to write. */ public void write(Type type, T value) { @@ -154,6 +160,7 @@ public class PacketWrapper { * Take a value from the input and write to the output. * * @param type The type to read and write. + * @param The return type of the type you wish to pass through. * @return The type which was read/written. * @throws Exception If it failed to read or write */ @@ -173,7 +180,7 @@ public class PacketWrapper { packetValues.addAll(readableObjects); readableObjects.clear(); // If the buffer has readable bytes, copy them. - if(inputBuffer.readableBytes() > 0){ + if (inputBuffer.readableBytes() > 0) { passthrough(Type.REMAINING_BYTES); } } diff --git a/src/main/java/us/myles/ViaVersion/api/ViaVersionAPI.java b/src/main/java/us/myles/ViaVersion/api/ViaVersionAPI.java index 3a3fc84ca..f2063d95f 100644 --- a/src/main/java/us/myles/ViaVersion/api/ViaVersionAPI.java +++ b/src/main/java/us/myles/ViaVersion/api/ViaVersionAPI.java @@ -38,7 +38,7 @@ public interface ViaVersionAPI { /** * Is player using 1.9? * - * @param playerUUID + * @param playerUUID UUID of a player * @return True if the client is on 1.9 */ boolean isPorted(UUID playerUUID); diff --git a/src/main/java/us/myles/ViaVersion/api/ViaVersionConfig.java b/src/main/java/us/myles/ViaVersion/api/ViaVersionConfig.java index 3c60ba098..726673793 100644 --- a/src/main/java/us/myles/ViaVersion/api/ViaVersionConfig.java +++ b/src/main/java/us/myles/ViaVersion/api/ViaVersionConfig.java @@ -111,7 +111,7 @@ public interface ViaVersionConfig { /** * Get the kick message sent if the user hits the max packets per second. * - * @return Kick message, with colour codes using '&' + * @return Kick message, with colour codes using '&' */ String getMaxPPSKickMessage(); @@ -139,7 +139,7 @@ public interface ViaVersionConfig { /** * Get the kick message sent if the user goes over the warnings in the interval * - * @return Kick message, with colour codes using '&' + * @return Kick message, with colour codes using '&' */ String getMaxWarningsKickMessage(); diff --git a/src/main/java/us/myles/ViaVersion/api/boss/BossBar.java b/src/main/java/us/myles/ViaVersion/api/boss/BossBar.java index 68a0ecbd3..fe9d20489 100644 --- a/src/main/java/us/myles/ViaVersion/api/boss/BossBar.java +++ b/src/main/java/us/myles/ViaVersion/api/boss/BossBar.java @@ -17,6 +17,7 @@ public interface BossBar { * Change the title * * @param title Title can be in either JSON or just text + * @return The BossBar object */ BossBar setTitle(String title); @@ -31,13 +32,14 @@ public interface BossBar { * Change the health * * @param health this float has to be between 0F - 1F + * @return The BossBar object */ BossBar setHealth(float health); /** * Get the bossbar color * - * @return + * @return The colour */ BossColor getColor(); @@ -45,6 +47,7 @@ public interface BossBar { * Yay colors! * * @param color Whatever color you want! + * @return The BossBar object */ BossBar setColor(BossColor color); @@ -59,13 +62,15 @@ public interface BossBar { * Change the bosbar style * * @param style BossStyle + * @return The BossBar object */ BossBar setStyle(BossStyle style); /** * Show the bossbar to a player. * - * @param player + * @param player The player + * @return The BossBar object */ BossBar addPlayer(Player player); @@ -73,7 +78,7 @@ public interface BossBar { * Show the bossbar to a player (uuid) * * @param player uuid of the player - * @return the BossBar instance + * @return The BossBar object */ BossBar addPlayer(UUID player); @@ -81,34 +86,37 @@ public interface BossBar { * add multiple players * * @param players list of players - * @return the bossbar instance + * @return The BossBar object */ BossBar addPlayers(Player... players); /** * Remove the bossbar from a player * - * @param player + * @param player The player + * @return The BossBar object */ BossBar removePlayer(Player player); /** * Add flags * - * @param flag + * @param flag The flag to add + * @return The BossBar object */ BossBar addFlag(BossFlag flag); /** * Remove flags. * - * @param flag + * @param flag The flag to remove + * @return The BossBar object */ BossBar removeFlag(BossFlag flag); /** - * @param flag - * @return + * @param flag The flag to check against + * @return True if it has the flag */ boolean hasFlag(BossFlag flag); @@ -121,11 +129,15 @@ public interface BossBar { /** * Show the bossbar to everyone (In the getPlayer set) + * + * @return The BossBar object */ BossBar show(); /** * Hide the bossbar from everyone (In the getPlayer set) + * + * @return The BossBar object */ BossBar hide(); diff --git a/src/main/java/us/myles/ViaVersion/api/command/ViaSubCommand.java b/src/main/java/us/myles/ViaVersion/api/command/ViaSubCommand.java index f20e431ac..d3a658c6d 100644 --- a/src/main/java/us/myles/ViaVersion/api/command/ViaSubCommand.java +++ b/src/main/java/us/myles/ViaVersion/api/command/ViaSubCommand.java @@ -10,14 +10,14 @@ public abstract class ViaSubCommand { /** * Subcommand name * - * @return your input + * @return The command name */ public abstract String name(); /** * subcommand description, this'll show in /viaversion list * - * @return your input + * @return The command description */ public abstract String description(); @@ -25,7 +25,7 @@ public abstract class ViaSubCommand { * Usage example: * "playerversion [name]" * - * @return your input + * @return The command usage */ public String usage() { return name(); @@ -34,7 +34,7 @@ public abstract class ViaSubCommand { /** * Permission, null for everyone * - * @return + * @return The permission required to use the command */ public String permission() { return "viaversion.admin"; @@ -59,7 +59,7 @@ public abstract class ViaSubCommand { public List onTabComplete(CommandSender sender, String[] args) { return Collections.emptyList(); } - + public String color(String s) { return ViaCommandHandler.color(s); } diff --git a/src/main/java/us/myles/ViaVersion/api/data/UserConnection.java b/src/main/java/us/myles/ViaVersion/api/data/UserConnection.java index cb7588114..bb549637e 100644 --- a/src/main/java/us/myles/ViaVersion/api/data/UserConnection.java +++ b/src/main/java/us/myles/ViaVersion/api/data/UserConnection.java @@ -39,6 +39,7 @@ public class UserConnection { * Get an object from the storage * * @param objectClass The class of the object to get + * @param The type of the class you want to get. * @return The requested object */ public T get(Class objectClass) { @@ -102,6 +103,8 @@ public class UserConnection { /** * Used for incrementing the number of packets received from the client + * + * @return True if the interval has reset */ public boolean incrementReceived() { // handle stats @@ -125,8 +128,8 @@ public class UserConnection { * @param reason The reason to use, not used if player is not active. */ public void disconnect(final String reason) { - if(!getChannel().isOpen()) return; - if(pendingDisconnect) return; + if (!getChannel().isOpen()) return; + if (pendingDisconnect) return; pendingDisconnect = true; if (get(ProtocolInfo.class).getUuid() != null) { final UUID uuid = get(ProtocolInfo.class).getUuid(); diff --git a/src/main/java/us/myles/ViaVersion/api/minecraft/chunks/ChunkSection.java b/src/main/java/us/myles/ViaVersion/api/minecraft/chunks/ChunkSection.java index a943b4981..4478da01f 100644 --- a/src/main/java/us/myles/ViaVersion/api/minecraft/chunks/ChunkSection.java +++ b/src/main/java/us/myles/ViaVersion/api/minecraft/chunks/ChunkSection.java @@ -157,6 +157,7 @@ public class ChunkSection { * Get expected size of this chunk section. * * @return Amount of bytes sent by this section + * @throws Exception If it failed to calculate bits properly */ public int getExpectedSize() throws Exception { int bitsPerBlock = palette.size() > 255 ? 16 : 8; diff --git a/src/main/java/us/myles/ViaVersion/api/remapper/PacketRemapper.java b/src/main/java/us/myles/ViaVersion/api/remapper/PacketRemapper.java index 49380c683..c323e8aea 100644 --- a/src/main/java/us/myles/ViaVersion/api/remapper/PacketRemapper.java +++ b/src/main/java/us/myles/ViaVersion/api/remapper/PacketRemapper.java @@ -39,7 +39,9 @@ public abstract class PacketRemapper { * Map a type from an old type to a transformed new type. * * @param oldType The old type + * @param The old return type. * @param transformer The transformer to use to produce the new type. + * @param The new return type. */ public void map(Type oldType, ValueTransformer transformer) { map(new TypeRemapper(oldType), transformer); @@ -49,7 +51,8 @@ public abstract class PacketRemapper { * Map a type using a basic ValueReader to a ValueWriter * * @param inputReader The reader to read with. - * @param outputWriter The writer to write with. + * @param outputWriter The writer to write with + * @param The return type */ public void map(ValueReader inputReader, ValueWriter outputWriter) { valueRemappers.add(new Pair(inputReader, outputWriter));