From 0ecd899ec5af8498c7e2afa956b1c0c1ae49f65c Mon Sep 17 00:00:00 2001 From: Luck Date: Tue, 26 Jul 2016 03:12:27 +0100 Subject: [PATCH] Fix bad javadoc issues --- api/pom.xml | 1 + api/src/main/java/me/lucko/luckperms/api/Group.java | 1 + api/src/main/java/me/lucko/luckperms/api/User.java | 1 + bukkit/pom.xml | 6 +++--- bungee/pom.xml | 6 +++--- common/pom.xml | 3 ++- .../java/me/lucko/luckperms/commands/CommandManager.java | 3 ++- .../java/me/lucko/luckperms/commands/SubCommand.java | 9 +++++++++ .../main/java/me/lucko/luckperms/constants/Message.java | 8 ++++---- .../src/main/java/me/lucko/luckperms/groups/Group.java | 1 + common/src/main/java/me/lucko/luckperms/users/User.java | 1 + .../main/java/me/lucko/luckperms/users/UserManager.java | 4 ++-- .../src/main/java/me/lucko/luckperms/utils/DateUtil.java | 1 + 13 files changed, 31 insertions(+), 14 deletions(-) diff --git a/api/pom.xml b/api/pom.xml index a3bb357d3..2c39afd2a 100644 --- a/api/pom.xml +++ b/api/pom.xml @@ -9,6 +9,7 @@ 4.0.0 + 1.4 luckperms-api diff --git a/api/src/main/java/me/lucko/luckperms/api/Group.java b/api/src/main/java/me/lucko/luckperms/api/Group.java index 4bf595cda..ede2177a7 100644 --- a/api/src/main/java/me/lucko/luckperms/api/Group.java +++ b/api/src/main/java/me/lucko/luckperms/api/Group.java @@ -158,6 +158,7 @@ public interface Group extends PermissionObject { /** * Get a {@link List} of the groups the group inherits on a specific server * @param server the server to check + * @param world the world to check * @return a {@link List} of group names */ List getLocalGroups(String server, String world); diff --git a/api/src/main/java/me/lucko/luckperms/api/User.java b/api/src/main/java/me/lucko/luckperms/api/User.java index 0c9384969..d0fee8a9b 100644 --- a/api/src/main/java/me/lucko/luckperms/api/User.java +++ b/api/src/main/java/me/lucko/luckperms/api/User.java @@ -182,6 +182,7 @@ public interface User extends PermissionObject { /** * Get a {@link List} of the groups the user is a member of on a specific server * @param server the server to check + * @param world the world to check * @return a {@link List} of group names */ List getLocalGroups(String server, String world); diff --git a/bukkit/pom.xml b/bukkit/pom.xml index 42902e6bd..ffe5499a8 100644 --- a/bukkit/pom.xml +++ b/bukkit/pom.xml @@ -10,7 +10,7 @@ 4.0.0 luckperms-bukkit - $(project.parent.version) + 1.4 jar LuckPerms @@ -72,14 +72,14 @@ me.lucko.luckperms luckperms-common - ${project.parent.version} + 1.4 compile me.lucko.luckperms luckperms-api - ${project.parent.version} + 1.4 compile diff --git a/bungee/pom.xml b/bungee/pom.xml index 80609db61..ff6e821f0 100644 --- a/bungee/pom.xml +++ b/bungee/pom.xml @@ -10,7 +10,7 @@ 4.0.0 luckperms-bungee - $(project.parent.version) + 1.4 jar LuckPerms @@ -65,14 +65,14 @@ me.lucko.luckperms luckperms-common - ${project.parent.version} + 1.4 compile me.lucko.luckperms luckperms-api - ${project.parent.version} + 1.4 compile diff --git a/common/pom.xml b/common/pom.xml index 1b497b3b5..11cdab7bd 100644 --- a/common/pom.xml +++ b/common/pom.xml @@ -9,6 +9,7 @@ 4.0.0 + 1.4 luckperms-common @@ -29,7 +30,7 @@ me.lucko.luckperms luckperms-api - ${project.parent.version} + 1.4 compile diff --git a/common/src/main/java/me/lucko/luckperms/commands/CommandManager.java b/common/src/main/java/me/lucko/luckperms/commands/CommandManager.java index fddaa182e..96b139c2b 100644 --- a/common/src/main/java/me/lucko/luckperms/commands/CommandManager.java +++ b/common/src/main/java/me/lucko/luckperms/commands/CommandManager.java @@ -96,8 +96,9 @@ public class CommandManager { /** * Generic on command method to be called from the command executor object of the platform * @param sender who sent the command + * @param label the command label used * @param args the arguments provided - * @return if the command was successful (hint: it always is :> ) + * @return if the command was successful */ public boolean onCommand(Sender sender, String label, List args) { if (args.size() == 0) { diff --git a/common/src/main/java/me/lucko/luckperms/commands/SubCommand.java b/common/src/main/java/me/lucko/luckperms/commands/SubCommand.java index e88bfbe8d..c9e773b23 100644 --- a/common/src/main/java/me/lucko/luckperms/commands/SubCommand.java +++ b/common/src/main/java/me/lucko/luckperms/commands/SubCommand.java @@ -37,9 +37,18 @@ public abstract class SubCommand { Util.sendPluginMessage(sender, "&e-> &d" + String.format(getUsage(), label)); } + /* + * Returns a list of suggestions, which are empty by default. Sub classes that give tab complete suggestions override + * this method to give their own list. + */ + /** * Returns a list of suggestions, which are empty by default. Sub classes that give tab complete suggestions override * this method to give their own list. + * @param sender who is tab completing + * @param args the arguments so far + * @param plugin the plugin instance + * @return a list of suggestions */ public List onTabComplete(Sender sender, List args, LuckPermsPlugin plugin) { return Collections.emptyList(); diff --git a/common/src/main/java/me/lucko/luckperms/constants/Message.java b/common/src/main/java/me/lucko/luckperms/constants/Message.java index 71ec2f780..96382a28c 100644 --- a/common/src/main/java/me/lucko/luckperms/constants/Message.java +++ b/common/src/main/java/me/lucko/luckperms/constants/Message.java @@ -6,7 +6,7 @@ import me.lucko.luckperms.commands.Util; @SuppressWarnings("SpellCheckingInspection") public enum Message { - /** + /* * General & Commands */ PREFIX("&7&l[&b&lL&a&lP&7&l] &c", false), @@ -23,7 +23,7 @@ public enum Message { - /** + /* * Loading / Saving */ USER_NOT_FOUND("&eUser could not be found.", true), @@ -41,7 +41,7 @@ public enum Message { - /** + /* * Command Syntax */ USER_USE_ADDGROUP("Use the addgroup command instead of specifying the node.", true), @@ -57,7 +57,7 @@ public enum Message { SERVER_INVALID_ENTRY("Server names can only contain alphanumeric characters.", true), - /** + /* * Commands */ CREATE_SUCCESS("&b%s&a was successfully created.", true), diff --git a/common/src/main/java/me/lucko/luckperms/groups/Group.java b/common/src/main/java/me/lucko/luckperms/groups/Group.java index dbdbdfcdc..4a8031d55 100644 --- a/common/src/main/java/me/lucko/luckperms/groups/Group.java +++ b/common/src/main/java/me/lucko/luckperms/groups/Group.java @@ -234,6 +234,7 @@ public class Group extends PermissionObject { /** * Get a {@link List} of the groups the group inherits on a specific server * @param server the server to check + * @param world the world to check * @return a {@link List} of group names */ public List getLocalGroups(String server, String world) { diff --git a/common/src/main/java/me/lucko/luckperms/users/User.java b/common/src/main/java/me/lucko/luckperms/users/User.java index 61954eb59..9484b01f3 100644 --- a/common/src/main/java/me/lucko/luckperms/users/User.java +++ b/common/src/main/java/me/lucko/luckperms/users/User.java @@ -265,6 +265,7 @@ public abstract class User extends PermissionObject { /** * Get a {@link List} of the groups the user is a member of on a specific server * @param server the server to check + * @param world the world to check * @return a {@link List} of group names */ public List getLocalGroups(String server, String world) { diff --git a/common/src/main/java/me/lucko/luckperms/users/UserManager.java b/common/src/main/java/me/lucko/luckperms/users/UserManager.java index 403521966..c6f1f7589 100644 --- a/common/src/main/java/me/lucko/luckperms/users/UserManager.java +++ b/common/src/main/java/me/lucko/luckperms/users/UserManager.java @@ -48,7 +48,7 @@ public abstract class UserManager { } /** - * Add a user to the {@link #getUsers()} map + * Add a user to the users map * @param user the user to add */ public void setUser(User user) { @@ -56,7 +56,7 @@ public abstract class UserManager { } /** - * Updates (or sets if the user wasn't already loaded) a user in the {@link #getUsers()} map + * Updates (or sets if the user wasn't already loaded) a user in the users map * @param user The user to update or set */ public void updateOrSetUser(User user) { diff --git a/common/src/main/java/me/lucko/luckperms/utils/DateUtil.java b/common/src/main/java/me/lucko/luckperms/utils/DateUtil.java index ceccbac8f..88c7284a0 100644 --- a/common/src/main/java/me/lucko/luckperms/utils/DateUtil.java +++ b/common/src/main/java/me/lucko/luckperms/utils/DateUtil.java @@ -24,6 +24,7 @@ public class DateUtil { /** * Converts a time string to a unix timestamp * @param time the time string + * @param future if the date is in the future, as opposed to the past * @return a unix timestamp * @throws IllegalDateException if the date input was invalid */