Update invalid JavaDoc

This commit is contained in:
Esophose 2018-10-07 16:51:03 -06:00
parent 6fb22e16c7
commit 53fabbacae
11 changed files with 34 additions and 21 deletions

View file

@ -132,6 +132,8 @@ public class PlayerParticles extends JavaPlugin {
* Gets the database connection information from the config and tries to connect to the server * Gets the database connection information from the config and tries to connect to the server
* Removes old table from previous versions of the plugin * Removes old table from previous versions of the plugin
* Creates new tables if they don't exist * Creates new tables if they don't exist
*
* @param useMySql If we should use MySQL as the database type, if false, uses SQLite
*/ */
private void configureDatabase(boolean useMySql) { private void configureDatabase(boolean useMySql) {
if (useMySql) { if (useMySql) {

View file

@ -24,6 +24,7 @@ public interface CommandModule {
* *
* @param pplayer The PPlayer who is tab completing this command * @param pplayer The PPlayer who is tab completing this command
* @param args Arguments typed so far * @param args Arguments typed so far
* @return A list of possible argument values
*/ */
public List<String> onTabComplete(PPlayer pplayer, String[] args); public List<String> onTabComplete(PPlayer pplayer, String[] args);

View file

@ -752,6 +752,7 @@ public class PlayerParticlesGui extends BukkitRunnable implements Listener {
* Gets the icon for a given particle effect from the config * Gets the icon for a given particle effect from the config
* *
* @param effect The effect * @param effect The effect
* @param isActive If this effect is the current one active
* @return An ItemStack formatted to be displayed in the GUI * @return An ItemStack formatted to be displayed in the GUI
*/ */
private static ItemStack getItemForEffect(ParticleEffect effect, boolean isActive) { private static ItemStack getItemForEffect(ParticleEffect effect, boolean isActive) {
@ -775,6 +776,7 @@ public class PlayerParticlesGui extends BukkitRunnable implements Listener {
* Gets the icon for a given particle style from the config * Gets the icon for a given particle style from the config
* *
* @param style The style * @param style The style
* @param isActive If this style is the current one active
* @return An ItemStack formatted to be displayed in the GUI * @return An ItemStack formatted to be displayed in the GUI
*/ */
private static ItemStack getItemForStyle(ParticleStyle style, boolean isActive) { private static ItemStack getItemForStyle(ParticleStyle style, boolean isActive) {
@ -878,6 +880,8 @@ public class PlayerParticlesGui extends BukkitRunnable implements Listener {
/** /**
* Gets the icon for rainbow color/note data * Gets the icon for rainbow color/note data
* *
* @param currentColor The player's current color data
* @param dyeColor The color of the rainbow we're on
* @return An ItemStack formatted to be displayed in the GUI * @return An ItemStack formatted to be displayed in the GUI
*/ */
private static ItemStack getItemForRainbowColorData(OrdinaryColor currentColor, DyeColor dyeColor) { private static ItemStack getItemForRainbowColorData(OrdinaryColor currentColor, DyeColor dyeColor) {
@ -906,6 +910,8 @@ public class PlayerParticlesGui extends BukkitRunnable implements Listener {
/** /**
* Gets the icon for rainbow color/note data * Gets the icon for rainbow color/note data
* *
* @param currentColor The player's current note data
* @param dyeColor The color of the rainbow we're on
* @return An ItemStack formatted to be displayed in the GUI * @return An ItemStack formatted to be displayed in the GUI
*/ */
private static ItemStack getItemForRainbowNoteData(NoteColor currentColor, DyeColor dyeColor) { private static ItemStack getItemForRainbowNoteData(NoteColor currentColor, DyeColor dyeColor) {

View file

@ -336,7 +336,6 @@ public class DataManager {
* *
* @param playerUUID The player who owns the effect * @param playerUUID The player who owns the effect
* @param id The id of the effect to remove * @param id The id of the effect to remove
* @param callback The callback to execute with if the fixed effect was removed or not
*/ */
public static void removeFixedEffect(UUID playerUUID, int id) { public static void removeFixedEffect(UUID playerUUID, int id) {
async(() -> { async(() -> {
@ -377,7 +376,7 @@ public class DataManager {
/** /**
* Checks if the given player has reached the max number of fixed effects * Checks if the given player has reached the max number of fixed effects
* *
* @param pplayerUUID The player to check * @param pplayer The player to check
* @return If the player has reached the max number of fixed effects * @return If the player has reached the max number of fixed effects
*/ */
public static boolean hasPlayerReachedMaxFixedEffects(PPlayer pplayer) { public static boolean hasPlayerReachedMaxFixedEffects(PPlayer pplayer) {

View file

@ -175,7 +175,8 @@ public class LangManager {
/** /**
* Gets the message this enum represents * Gets the message this enum represents
* *
* @return The message * @param replacements The replacements for the message
* @return The message with the replacements applied
*/ */
private String get(Object... replacements) { private String get(Object... replacements) {
return new MessageFormat(this.message).format(replacements); return new MessageFormat(this.message).format(replacements);
@ -256,6 +257,7 @@ public class LangManager {
* *
* @param messageType The message type to get * @param messageType The message type to get
* @param replacements The replacements fot the message * @param replacements The replacements fot the message
* @return The Lang in text form with its replacements applied
*/ */
public static String getText(Lang messageType, Object... replacements) { public static String getText(Lang messageType, Object... replacements) {
return messageType.get(replacements); return messageType.get(replacements);
@ -266,6 +268,7 @@ public class LangManager {
* *
* @param player The player to send the message to * @param player The player to send the message to
* @param messageType The message to send to the player * @param messageType The message to send to the player
* @param replacements The replacements for the message
*/ */
public static void sendMessage(Player player, Lang messageType, Object... replacements) { public static void sendMessage(Player player, Lang messageType, Object... replacements) {
if (!messagesEnabled) return; if (!messagesEnabled) return;
@ -288,6 +291,7 @@ public class LangManager {
* *
* @param pplayer The player to send the message to * @param pplayer The player to send the message to
* @param messageType The message to send to the player * @param messageType The message to send to the player
* @param replacements The replacements for the message
*/ */
public static void sendMessage(PPlayer pplayer, Lang messageType, Object... replacements) { public static void sendMessage(PPlayer pplayer, Lang messageType, Object... replacements) {
sendMessage(pplayer.getPlayer(), messageType, replacements); sendMessage(pplayer.getPlayer(), messageType, replacements);

View file

@ -18,12 +18,12 @@ public class PPlayer {
private final UUID playerUUID; private final UUID playerUUID;
/** /**
* A List<ParticleGroup> of all particle groups this player has, the active particle group has an id of null * A List of ParticleGroups this player has, the active particle group has an id of null
*/ */
private List<ParticleGroup> particleGroups; private List<ParticleGroup> particleGroups;
/** /**
* A List<FixedParticleEffect> of all fixed particles this user has applied * A List of FixedParticleEffects this user has applied
*/ */
private List<FixedParticleEffect> fixedParticles; private List<FixedParticleEffect> fixedParticles;
@ -31,8 +31,8 @@ public class PPlayer {
* Constructs a new PPlayer * Constructs a new PPlayer
* *
* @param uuid The player UUID * @param uuid The player UUID
* @param particlePairs The ParticlePairs this PPlayer has * @param particleGroups The ParticleGroups this PPlayer has
* @param fixedParticles2 The fixed ParticlePairs this PPlayer has * @param fixedParticles The FixedParticleEffects this PPlayer has
*/ */
public PPlayer(UUID uuid, List<ParticleGroup> particleGroups, List<FixedParticleEffect> fixedParticles) { public PPlayer(UUID uuid, List<ParticleGroup> particleGroups, List<FixedParticleEffect> fixedParticles) {
this.playerUUID = uuid; this.playerUUID = uuid;
@ -59,9 +59,9 @@ public class PPlayer {
} }
/** /**
* Get a List<ParticleGroup> of all particles this user has saved * Get a List of ParticleGroups this user has saved
* *
* @return A list of all particle groups this player has * @return A List of ParticleGroups this player has
*/ */
public List<ParticleGroup> getParticles() { public List<ParticleGroup> getParticles() {
return this.particleGroups; return this.particleGroups;
@ -83,7 +83,7 @@ public class PPlayer {
/** /**
* Get the effect/style/data for particles this player has set * Get the effect/style/data for particles this player has set
* *
* @return A List<ParticlePair> of all particles this player has set * @return A List of ParticlePairs this player has set
*/ */
public List<ParticlePair> getActiveParticles() { public List<ParticlePair> getActiveParticles() {
return this.getActiveParticleGroup().getParticles(); return this.getActiveParticleGroup().getParticles();
@ -105,7 +105,7 @@ public class PPlayer {
* Get all ParticlePairs with a style matching the input * Get all ParticlePairs with a style matching the input
* *
* @param style The style to match * @param style The style to match
* @return A List<ParticlePair> with a matching style * @return A List of ParticlePairs with a matching style
*/ */
public List<ParticlePair> getActiveParticlesForStyle(ParticleStyle style) { public List<ParticlePair> getActiveParticlesForStyle(ParticleStyle style) {
List<ParticlePair> matches = new ArrayList<ParticlePair>(); List<ParticlePair> matches = new ArrayList<ParticlePair>();
@ -131,7 +131,7 @@ public class PPlayer {
/** /**
* Get the effect/style/data for all fixed particles this has has set * Get the effect/style/data for all fixed particles this has has set
* *
* @return A List<FixedParticleEffect> of all fixed particles this player has set * @return A List of FixedParticleEffects this player has set
*/ */
public List<FixedParticleEffect> getFixedParticles() { public List<FixedParticleEffect> getFixedParticles() {
return this.fixedParticles; return this.fixedParticles;
@ -153,7 +153,7 @@ public class PPlayer {
/** /**
* Gets a list of ids of all fixed effect this player has * Gets a list of ids of all fixed effect this player has
* *
* @return A List<Integer> of ids this player's fixed effects have * @return A List of Integer ids this player's fixed effects have
*/ */
public List<Integer> getFixedEffectIds() { public List<Integer> getFixedEffectIds() {
List<Integer> ids = new ArrayList<Integer>(); List<Integer> ids = new ArrayList<Integer>();

View file

@ -103,8 +103,8 @@ public enum ParticleEffect {
/** /**
* Construct a new particle effect * Construct a new particle effect
* *
* @param enumName Name of the Particle Enum when the server version is >= 1.13 * @param enumName Name of the Particle Enum when the server version is greater than or equal to 1.13
* @param enumNameLegacy Name of the Particle Enum when the server version is < 1.13 * @param enumNameLegacy Name of the Particle Enum when the server version is less than 1.13
* @param properties Properties of this particle effect * @param properties Properties of this particle effect
*/ */
private ParticleEffect(String enumName, String enumNameLegacy, ParticleProperty... properties) { private ParticleEffect(String enumName, String enumNameLegacy, ParticleProperty... properties) {
@ -281,10 +281,10 @@ public enum ParticleEffect {
} }
/** /**
* Gets a List<Player> of players within the particle display range * Gets a List of Players within the particle display range
* *
* @param center The center of the radius to check around * @param center The center of the radius to check around
* @return A List<Player> of the players within the particle display range * @return A List of Players within the particle display range
*/ */
private List<Player> getPlayersInRange(Location center) { private List<Player> getPlayersInRange(Location center) {
List<Player> players = new ArrayList<Player>(); List<Player> players = new ArrayList<Player>();

View file

@ -26,7 +26,7 @@ public class ParticleGroup {
} }
/** /**
* Get the List<ParticlePair> of particles in this group * Get the List of ParticlePairs in this group
* *
* @return The particles in this group * @return The particles in this group
*/ */

View file

@ -262,6 +262,7 @@ public class ParticlePair {
/** /**
* Gets a ParticlePair with the default values applied * Gets a ParticlePair with the default values applied
* *
* @param ownerUUID The owner of this ParticlePair
* @return A ParticlePair with default values * @return A ParticlePair with default values
*/ */
@Deprecated // TODO: REMOVE ONCE NEW GUI IS DONE @Deprecated // TODO: REMOVE ONCE NEW GUI IS DONE

View file

@ -11,9 +11,9 @@ public interface ParticleStyle {
/** /**
* Gets all the particles to display based on the style's logic * Gets all the particles to display based on the style's logic
* *
* @param pplayer The PPlayer to display the particles for * @param particle The ParticlePair that contains the particle's data
* @param location The central location of the particles * @param location The central location of the particles
* @return A List<PParticle> of PParticles to spawn * @return A List of PParticles to spawn
*/ */
public List<PParticle> getParticles(ParticlePair particle, Location location); public List<PParticle> getParticles(ParticlePair particle, Location location);

View file

@ -52,7 +52,7 @@ public class ParticleStyleManager {
/** /**
* Gets all registered styles * Gets all registered styles
* *
* @return A List<ParticleStyle> of all registered styles * @return A List of ParticleStyles that are registered
*/ */
public static List<ParticleStyle> getStyles() { public static List<ParticleStyle> getStyles() {
return styles; return styles;