Fix bad javadoc issues

This commit is contained in:
Luck 2016-07-26 03:12:27 +01:00
parent e9805b7532
commit 0ecd899ec5
13 changed files with 31 additions and 14 deletions

View File

@ -9,6 +9,7 @@
</parent>
<modelVersion>4.0.0</modelVersion>
<version>1.4</version>
<artifactId>luckperms-api</artifactId>
<build>
<plugins>

View File

@ -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<String> getLocalGroups(String server, String world);

View File

@ -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<String> getLocalGroups(String server, String world);

View File

@ -10,7 +10,7 @@
<modelVersion>4.0.0</modelVersion>
<artifactId>luckperms-bukkit</artifactId>
<version>$(project.parent.version)</version>
<version>1.4</version>
<packaging>jar</packaging>
<name>LuckPerms</name>
@ -72,14 +72,14 @@
<dependency>
<groupId>me.lucko.luckperms</groupId>
<artifactId>luckperms-common</artifactId>
<version>${project.parent.version}</version>
<version>1.4</version>
<scope>compile</scope>
</dependency>
<!-- LuckPerms API -->
<dependency>
<groupId>me.lucko.luckperms</groupId>
<artifactId>luckperms-api</artifactId>
<version>${project.parent.version}</version>
<version>1.4</version>
<scope>compile</scope>
</dependency>
</dependencies>

View File

@ -10,7 +10,7 @@
<modelVersion>4.0.0</modelVersion>
<artifactId>luckperms-bungee</artifactId>
<version>$(project.parent.version)</version>
<version>1.4</version>
<packaging>jar</packaging>
<name>LuckPerms</name>
@ -65,14 +65,14 @@
<dependency>
<groupId>me.lucko.luckperms</groupId>
<artifactId>luckperms-common</artifactId>
<version>${project.parent.version}</version>
<version>1.4</version>
<scope>compile</scope>
</dependency>
<!-- LuckPerms API -->
<dependency>
<groupId>me.lucko.luckperms</groupId>
<artifactId>luckperms-api</artifactId>
<version>${project.parent.version}</version>
<version>1.4</version>
<scope>compile</scope>
</dependency>
</dependencies>

View File

@ -9,6 +9,7 @@
</parent>
<modelVersion>4.0.0</modelVersion>
<version>1.4</version>
<artifactId>luckperms-common</artifactId>
<build>
<plugins>
@ -29,7 +30,7 @@
<dependency>
<groupId>me.lucko.luckperms</groupId>
<artifactId>luckperms-api</artifactId>
<version>${project.parent.version}</version>
<version>1.4</version>
<scope>compile</scope>
</dependency>
</dependencies>

View File

@ -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<String> args) {
if (args.size() == 0) {

View File

@ -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<String> onTabComplete(Sender sender, List<String> args, LuckPermsPlugin plugin) {
return Collections.emptyList();

View File

@ -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),

View File

@ -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<String> getLocalGroups(String server, String world) {

View File

@ -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<String> getLocalGroups(String server, String world) {

View File

@ -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) {

View File

@ -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
*/