mirror of
https://github.com/LuckPerms/LuckPerms.git
synced 2024-11-24 11:38:40 +01:00
Fix bad javadoc issues
This commit is contained in:
parent
e9805b7532
commit
0ecd899ec5
@ -9,6 +9,7 @@
|
|||||||
</parent>
|
</parent>
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
|
<version>1.4</version>
|
||||||
<artifactId>luckperms-api</artifactId>
|
<artifactId>luckperms-api</artifactId>
|
||||||
<build>
|
<build>
|
||||||
<plugins>
|
<plugins>
|
||||||
|
@ -158,6 +158,7 @@ public interface Group extends PermissionObject {
|
|||||||
/**
|
/**
|
||||||
* Get a {@link List} of the groups the group inherits on a specific server
|
* Get a {@link List} of the groups the group inherits on a specific server
|
||||||
* @param server the server to check
|
* @param server the server to check
|
||||||
|
* @param world the world to check
|
||||||
* @return a {@link List} of group names
|
* @return a {@link List} of group names
|
||||||
*/
|
*/
|
||||||
List<String> getLocalGroups(String server, String world);
|
List<String> getLocalGroups(String server, String world);
|
||||||
|
@ -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
|
* Get a {@link List} of the groups the user is a member of on a specific server
|
||||||
* @param server the server to check
|
* @param server the server to check
|
||||||
|
* @param world the world to check
|
||||||
* @return a {@link List} of group names
|
* @return a {@link List} of group names
|
||||||
*/
|
*/
|
||||||
List<String> getLocalGroups(String server, String world);
|
List<String> getLocalGroups(String server, String world);
|
||||||
|
@ -10,7 +10,7 @@
|
|||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
<artifactId>luckperms-bukkit</artifactId>
|
<artifactId>luckperms-bukkit</artifactId>
|
||||||
<version>$(project.parent.version)</version>
|
<version>1.4</version>
|
||||||
<packaging>jar</packaging>
|
<packaging>jar</packaging>
|
||||||
<name>LuckPerms</name>
|
<name>LuckPerms</name>
|
||||||
|
|
||||||
@ -72,14 +72,14 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>me.lucko.luckperms</groupId>
|
<groupId>me.lucko.luckperms</groupId>
|
||||||
<artifactId>luckperms-common</artifactId>
|
<artifactId>luckperms-common</artifactId>
|
||||||
<version>${project.parent.version}</version>
|
<version>1.4</version>
|
||||||
<scope>compile</scope>
|
<scope>compile</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
<!-- LuckPerms API -->
|
<!-- LuckPerms API -->
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>me.lucko.luckperms</groupId>
|
<groupId>me.lucko.luckperms</groupId>
|
||||||
<artifactId>luckperms-api</artifactId>
|
<artifactId>luckperms-api</artifactId>
|
||||||
<version>${project.parent.version}</version>
|
<version>1.4</version>
|
||||||
<scope>compile</scope>
|
<scope>compile</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
@ -10,7 +10,7 @@
|
|||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
<artifactId>luckperms-bungee</artifactId>
|
<artifactId>luckperms-bungee</artifactId>
|
||||||
<version>$(project.parent.version)</version>
|
<version>1.4</version>
|
||||||
<packaging>jar</packaging>
|
<packaging>jar</packaging>
|
||||||
<name>LuckPerms</name>
|
<name>LuckPerms</name>
|
||||||
|
|
||||||
@ -65,14 +65,14 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>me.lucko.luckperms</groupId>
|
<groupId>me.lucko.luckperms</groupId>
|
||||||
<artifactId>luckperms-common</artifactId>
|
<artifactId>luckperms-common</artifactId>
|
||||||
<version>${project.parent.version}</version>
|
<version>1.4</version>
|
||||||
<scope>compile</scope>
|
<scope>compile</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
<!-- LuckPerms API -->
|
<!-- LuckPerms API -->
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>me.lucko.luckperms</groupId>
|
<groupId>me.lucko.luckperms</groupId>
|
||||||
<artifactId>luckperms-api</artifactId>
|
<artifactId>luckperms-api</artifactId>
|
||||||
<version>${project.parent.version}</version>
|
<version>1.4</version>
|
||||||
<scope>compile</scope>
|
<scope>compile</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
@ -9,6 +9,7 @@
|
|||||||
</parent>
|
</parent>
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
|
<version>1.4</version>
|
||||||
<artifactId>luckperms-common</artifactId>
|
<artifactId>luckperms-common</artifactId>
|
||||||
<build>
|
<build>
|
||||||
<plugins>
|
<plugins>
|
||||||
@ -29,7 +30,7 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>me.lucko.luckperms</groupId>
|
<groupId>me.lucko.luckperms</groupId>
|
||||||
<artifactId>luckperms-api</artifactId>
|
<artifactId>luckperms-api</artifactId>
|
||||||
<version>${project.parent.version}</version>
|
<version>1.4</version>
|
||||||
<scope>compile</scope>
|
<scope>compile</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
@ -96,8 +96,9 @@ public class CommandManager {
|
|||||||
/**
|
/**
|
||||||
* Generic on command method to be called from the command executor object of the platform
|
* Generic on command method to be called from the command executor object of the platform
|
||||||
* @param sender who sent the command
|
* @param sender who sent the command
|
||||||
|
* @param label the command label used
|
||||||
* @param args the arguments provided
|
* @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) {
|
public boolean onCommand(Sender sender, String label, List<String> args) {
|
||||||
if (args.size() == 0) {
|
if (args.size() == 0) {
|
||||||
|
@ -37,9 +37,18 @@ public abstract class SubCommand {
|
|||||||
Util.sendPluginMessage(sender, "&e-> &d" + String.format(getUsage(), label));
|
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
|
* 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.
|
* 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) {
|
public List<String> onTabComplete(Sender sender, List<String> args, LuckPermsPlugin plugin) {
|
||||||
return Collections.emptyList();
|
return Collections.emptyList();
|
||||||
|
@ -6,7 +6,7 @@ import me.lucko.luckperms.commands.Util;
|
|||||||
@SuppressWarnings("SpellCheckingInspection")
|
@SuppressWarnings("SpellCheckingInspection")
|
||||||
public enum Message {
|
public enum Message {
|
||||||
|
|
||||||
/**
|
/*
|
||||||
* General & Commands
|
* General & Commands
|
||||||
*/
|
*/
|
||||||
PREFIX("&7&l[&b&lL&a&lP&7&l] &c", false),
|
PREFIX("&7&l[&b&lL&a&lP&7&l] &c", false),
|
||||||
@ -23,7 +23,7 @@ public enum Message {
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/*
|
||||||
* Loading / Saving
|
* Loading / Saving
|
||||||
*/
|
*/
|
||||||
USER_NOT_FOUND("&eUser could not be found.", true),
|
USER_NOT_FOUND("&eUser could not be found.", true),
|
||||||
@ -41,7 +41,7 @@ public enum Message {
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/*
|
||||||
* Command Syntax
|
* Command Syntax
|
||||||
*/
|
*/
|
||||||
USER_USE_ADDGROUP("Use the addgroup command instead of specifying the node.", true),
|
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),
|
SERVER_INVALID_ENTRY("Server names can only contain alphanumeric characters.", true),
|
||||||
|
|
||||||
|
|
||||||
/**
|
/*
|
||||||
* Commands
|
* Commands
|
||||||
*/
|
*/
|
||||||
CREATE_SUCCESS("&b%s&a was successfully created.", true),
|
CREATE_SUCCESS("&b%s&a was successfully created.", true),
|
||||||
|
@ -234,6 +234,7 @@ public class Group extends PermissionObject {
|
|||||||
/**
|
/**
|
||||||
* Get a {@link List} of the groups the group inherits on a specific server
|
* Get a {@link List} of the groups the group inherits on a specific server
|
||||||
* @param server the server to check
|
* @param server the server to check
|
||||||
|
* @param world the world to check
|
||||||
* @return a {@link List} of group names
|
* @return a {@link List} of group names
|
||||||
*/
|
*/
|
||||||
public List<String> getLocalGroups(String server, String world) {
|
public List<String> getLocalGroups(String server, String world) {
|
||||||
|
@ -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
|
* Get a {@link List} of the groups the user is a member of on a specific server
|
||||||
* @param server the server to check
|
* @param server the server to check
|
||||||
|
* @param world the world to check
|
||||||
* @return a {@link List} of group names
|
* @return a {@link List} of group names
|
||||||
*/
|
*/
|
||||||
public List<String> getLocalGroups(String server, String world) {
|
public List<String> getLocalGroups(String server, String world) {
|
||||||
|
@ -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
|
* @param user the user to add
|
||||||
*/
|
*/
|
||||||
public void setUser(User user) {
|
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
|
* @param user The user to update or set
|
||||||
*/
|
*/
|
||||||
public void updateOrSetUser(User user) {
|
public void updateOrSetUser(User user) {
|
||||||
|
@ -24,6 +24,7 @@ public class DateUtil {
|
|||||||
/**
|
/**
|
||||||
* Converts a time string to a unix timestamp
|
* Converts a time string to a unix timestamp
|
||||||
* @param time the time string
|
* @param time the time string
|
||||||
|
* @param future if the date is in the future, as opposed to the past
|
||||||
* @return a unix timestamp
|
* @return a unix timestamp
|
||||||
* @throws IllegalDateException if the date input was invalid
|
* @throws IllegalDateException if the date input was invalid
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user