From afa37505c5a10aab3781986bdc15f87f8efe29f6 Mon Sep 17 00:00:00 2001 From: Jonas Konrad Date: Sat, 28 Jun 2014 00:39:27 +0200 Subject: [PATCH] Fix javadocs for java 8 doclint --- .../java/net/md_5/bungee/api/chat/BaseComponent.java | 2 -- .../java/net/md_5/bungee/api/chat/ClickEvent.java | 11 ++++++----- .../net/md_5/bungee/api/chat/ComponentBuilder.java | 9 +++++---- .../md_5/bungee/api/chat/TranslatableComponent.java | 2 +- .../md_5/bungee/api/connection/PendingConnection.java | 2 -- .../net/md_5/bungee/api/plugin/PluginManager.java | 2 -- .../java/net/md_5/bungee/api/tab/TabListHandler.java | 6 ------ .../java/net/md_5/bungee/protocol/packet/Team.java | 2 -- 8 files changed, 12 insertions(+), 24 deletions(-) diff --git a/api/src/main/java/net/md_5/bungee/api/chat/BaseComponent.java b/api/src/main/java/net/md_5/bungee/api/chat/BaseComponent.java index 66d7a1e1..bd5b9178 100644 --- a/api/src/main/java/net/md_5/bungee/api/chat/BaseComponent.java +++ b/api/src/main/java/net/md_5/bungee/api/chat/BaseComponent.java @@ -315,8 +315,6 @@ public abstract class BaseComponent /** * Returns whether the component has any formatting or events applied to it - * - * @return */ public boolean hasFormatting() { diff --git a/api/src/main/java/net/md_5/bungee/api/chat/ClickEvent.java b/api/src/main/java/net/md_5/bungee/api/chat/ClickEvent.java index 222451d5..769c8c26 100644 --- a/api/src/main/java/net/md_5/bungee/api/chat/ClickEvent.java +++ b/api/src/main/java/net/md_5/bungee/api/chat/ClickEvent.java @@ -4,6 +4,7 @@ import lombok.AllArgsConstructor; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; +import net.md_5.bungee.api.chat.ClickEvent.Action; @Getter @AllArgsConstructor @@ -17,7 +18,7 @@ final public class ClickEvent /** * Depends on action * - * @see net.md_5.bungee.api.chat.ClickEvent.Action + * @see Action */ private final String value; @@ -26,22 +27,22 @@ final public class ClickEvent /** * Open a url at the path given by - * {@link net.md_5.bungee.api.chat.ClickEvent#getValue()} + * {@link net.md_5.bungee.api.chat.ClickEvent#value} */ OPEN_URL, /** * Open a file at the path given by - * {@link net.md_5.bungee.api.chat.ClickEvent#getValue()} + * {@link net.md_5.bungee.api.chat.ClickEvent#value} */ OPEN_FILE, /** * Run the command given by - * {@link net.md_5.bungee.api.chat.ClickEvent#getValue()} + * {@link net.md_5.bungee.api.chat.ClickEvent#value} */ RUN_COMMAND, /** * Inserts the string given by - * {@link net.md_5.bungee.api.chat.ClickEvent#getValue()} into the + * {@link net.md_5.bungee.api.chat.ClickEvent#value} into the * players text box */ SUGGEST_COMMAND diff --git a/api/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java b/api/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java index 16a0e2e1..007629c2 100644 --- a/api/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java +++ b/api/src/main/java/net/md_5/bungee/api/chat/ComponentBuilder.java @@ -7,21 +7,22 @@ import java.util.ArrayList; import java.util.List; /** + *

* ComponentBuilder simplifies creating basic messages by allowing the use of a * chainable builder. - *

- * < - * pre> + *

+ * 
  * new ComponentBuilder("Hello ").color(ChatColor.RED).
  * append("World").color(ChatColor.BLUE). append("!").bold(true).create();
  *
- *

+ *

* All methods (excluding {@link #append(String)} and {@link #create()} work on * the last part appended to the builder, so in the example above "Hello " would * be {@link net.md_5.bungee.api.ChatColor#RED} and "World" would be * {@link net.md_5.bungee.api.ChatColor#BLUE} but "!" would be bold and * {@link net.md_5.bungee.api.ChatColor#BLUE} because append copies the previous * part's formatting + *

*/ public class ComponentBuilder { diff --git a/api/src/main/java/net/md_5/bungee/api/chat/TranslatableComponent.java b/api/src/main/java/net/md_5/bungee/api/chat/TranslatableComponent.java index 900c4f36..bb162918 100644 --- a/api/src/main/java/net/md_5/bungee/api/chat/TranslatableComponent.java +++ b/api/src/main/java/net/md_5/bungee/api/chat/TranslatableComponent.java @@ -34,7 +34,7 @@ public class TranslatableComponent extends BaseComponent /** * Creates a translatable component with the passed substitutions * - * @see #setTranslate(String) + * @see #translate * @see #setWith(java.util.List) * @param translate the translation key * @param with the {@link java.lang.String}s and diff --git a/api/src/main/java/net/md_5/bungee/api/connection/PendingConnection.java b/api/src/main/java/net/md_5/bungee/api/connection/PendingConnection.java index 203de9cf..98456e4b 100644 --- a/api/src/main/java/net/md_5/bungee/api/connection/PendingConnection.java +++ b/api/src/main/java/net/md_5/bungee/api/connection/PendingConnection.java @@ -63,8 +63,6 @@ public interface PendingConnection extends Connection /** * Set this connection's online mode. - * - * @param onlineMode */ void setOnlineMode(boolean onlineMode); } 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 e3d2c1cf..413e5cff 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 @@ -397,8 +397,6 @@ public class PluginManager /** * Unregister all of a Plugin's listener. - * - * @param plugin */ public void unregisterListeners(Plugin plugin) { diff --git a/api/src/main/java/net/md_5/bungee/api/tab/TabListHandler.java b/api/src/main/java/net/md_5/bungee/api/tab/TabListHandler.java index bcc159ec..4b147a4a 100644 --- a/api/src/main/java/net/md_5/bungee/api/tab/TabListHandler.java +++ b/api/src/main/java/net/md_5/bungee/api/tab/TabListHandler.java @@ -25,8 +25,6 @@ public interface TabListHandler /** * Called when a player first connects to the proxy. - * - * @param player the connecting player */ void onServerChange(); @@ -34,22 +32,18 @@ public interface TabListHandler * Called when a players ping changes. The new ping will have not updated in * the player instance until this method returns. * - * @param player the player who's ping changed * @param ping the player's new ping. */ void onPingChange(int ping); /** * Called when a player disconnects. - * - * @param player the disconnected player */ void onDisconnect(); /** * Called when a list update packet is sent from server to client. * - * @param player receiving this packet * @param name the player which this packet is relevant to * @param online whether the subject player is online * @param ping ping of the subject player diff --git a/protocol/src/main/java/net/md_5/bungee/protocol/packet/Team.java b/protocol/src/main/java/net/md_5/bungee/protocol/packet/Team.java index 34dbaa46..792302c6 100644 --- a/protocol/src/main/java/net/md_5/bungee/protocol/packet/Team.java +++ b/protocol/src/main/java/net/md_5/bungee/protocol/packet/Team.java @@ -31,8 +31,6 @@ public class Team extends DefinedPacket /** * Packet to destroy a team. - * - * @param name */ public Team(String name) {