diff --git a/src/com/esophose/playerparticles/PlayerParticles.java b/src/com/esophose/playerparticles/PlayerParticles.java index 93a9a32..ef5b5b5 100644 --- a/src/com/esophose/playerparticles/PlayerParticles.java +++ b/src/com/esophose/playerparticles/PlayerParticles.java @@ -132,6 +132,8 @@ public class PlayerParticles extends JavaPlugin { * Gets the database connection information from the config and tries to connect to the server * Removes old table from previous versions of the plugin * 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) { if (useMySql) { diff --git a/src/com/esophose/playerparticles/command/CommandModule.java b/src/com/esophose/playerparticles/command/CommandModule.java index 5f45ca1..e74cb9f 100644 --- a/src/com/esophose/playerparticles/command/CommandModule.java +++ b/src/com/esophose/playerparticles/command/CommandModule.java @@ -24,6 +24,7 @@ public interface CommandModule { * * @param pplayer The PPlayer who is tab completing this command * @param args Arguments typed so far + * @return A list of possible argument values */ public List onTabComplete(PPlayer pplayer, String[] args); diff --git a/src/com/esophose/playerparticles/gui/PlayerParticlesGui.java b/src/com/esophose/playerparticles/gui/PlayerParticlesGui.java index e7ed14d..726b33a 100644 --- a/src/com/esophose/playerparticles/gui/PlayerParticlesGui.java +++ b/src/com/esophose/playerparticles/gui/PlayerParticlesGui.java @@ -752,6 +752,7 @@ public class PlayerParticlesGui extends BukkitRunnable implements Listener { * Gets the icon for a given particle effect from the config * * @param effect The effect + * @param isActive If this effect is the current one active * @return An ItemStack formatted to be displayed in the GUI */ 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 * * @param style The style + * @param isActive If this style is the current one active * @return An ItemStack formatted to be displayed in the GUI */ 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 * + * @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 */ 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 * + * @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 */ private static ItemStack getItemForRainbowNoteData(NoteColor currentColor, DyeColor dyeColor) { diff --git a/src/com/esophose/playerparticles/manager/DataManager.java b/src/com/esophose/playerparticles/manager/DataManager.java index 521fdb2..00ecee5 100644 --- a/src/com/esophose/playerparticles/manager/DataManager.java +++ b/src/com/esophose/playerparticles/manager/DataManager.java @@ -336,7 +336,6 @@ public class DataManager { * * @param playerUUID The player who owns the effect * @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) { async(() -> { @@ -377,7 +376,7 @@ public class DataManager { /** * 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 */ public static boolean hasPlayerReachedMaxFixedEffects(PPlayer pplayer) { diff --git a/src/com/esophose/playerparticles/manager/LangManager.java b/src/com/esophose/playerparticles/manager/LangManager.java index f4afb71..8e7fb03 100644 --- a/src/com/esophose/playerparticles/manager/LangManager.java +++ b/src/com/esophose/playerparticles/manager/LangManager.java @@ -175,7 +175,8 @@ public class LangManager { /** * 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) { return new MessageFormat(this.message).format(replacements); @@ -256,6 +257,7 @@ public class LangManager { * * @param messageType The message type to get * @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) { return messageType.get(replacements); @@ -266,6 +268,7 @@ public class LangManager { * * @param player The player to send the message to * @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) { if (!messagesEnabled) return; @@ -288,6 +291,7 @@ public class LangManager { * * @param pplayer The player to send the message to * @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) { sendMessage(pplayer.getPlayer(), messageType, replacements); diff --git a/src/com/esophose/playerparticles/particles/PPlayer.java b/src/com/esophose/playerparticles/particles/PPlayer.java index 3800dc5..053f46f 100644 --- a/src/com/esophose/playerparticles/particles/PPlayer.java +++ b/src/com/esophose/playerparticles/particles/PPlayer.java @@ -18,12 +18,12 @@ public class PPlayer { private final UUID playerUUID; /** - * A List 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 particleGroups; /** - * A List of all fixed particles this user has applied + * A List of FixedParticleEffects this user has applied */ private List fixedParticles; @@ -31,8 +31,8 @@ public class PPlayer { * Constructs a new PPlayer * * @param uuid The player UUID - * @param particlePairs The ParticlePairs this PPlayer has - * @param fixedParticles2 The fixed ParticlePairs this PPlayer has + * @param particleGroups The ParticleGroups this PPlayer has + * @param fixedParticles The FixedParticleEffects this PPlayer has */ public PPlayer(UUID uuid, List particleGroups, List fixedParticles) { this.playerUUID = uuid; @@ -59,9 +59,9 @@ public class PPlayer { } /** - * Get a List 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 getParticles() { return this.particleGroups; @@ -83,7 +83,7 @@ public class PPlayer { /** * Get the effect/style/data for particles this player has set * - * @return A List of all particles this player has set + * @return A List of ParticlePairs this player has set */ public List getActiveParticles() { return this.getActiveParticleGroup().getParticles(); @@ -105,7 +105,7 @@ public class PPlayer { * Get all ParticlePairs with a style matching the input * * @param style The style to match - * @return A List with a matching style + * @return A List of ParticlePairs with a matching style */ public List getActiveParticlesForStyle(ParticleStyle style) { List matches = new ArrayList(); @@ -131,7 +131,7 @@ public class PPlayer { /** * Get the effect/style/data for all fixed particles this has has set * - * @return A List of all fixed particles this player has set + * @return A List of FixedParticleEffects this player has set */ public List getFixedParticles() { return this.fixedParticles; @@ -153,7 +153,7 @@ public class PPlayer { /** * Gets a list of ids of all fixed effect this player has * - * @return A List of ids this player's fixed effects have + * @return A List of Integer ids this player's fixed effects have */ public List getFixedEffectIds() { List ids = new ArrayList(); diff --git a/src/com/esophose/playerparticles/particles/ParticleEffect.java b/src/com/esophose/playerparticles/particles/ParticleEffect.java index 6486b9c..b78cdbb 100644 --- a/src/com/esophose/playerparticles/particles/ParticleEffect.java +++ b/src/com/esophose/playerparticles/particles/ParticleEffect.java @@ -103,8 +103,8 @@ public enum ParticleEffect { /** * Construct a new particle effect * - * @param enumName Name of the Particle Enum when the server version is >= 1.13 - * @param enumNameLegacy 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 less than 1.13 * @param properties Properties of this particle effect */ private ParticleEffect(String enumName, String enumNameLegacy, ParticleProperty... properties) { @@ -281,10 +281,10 @@ public enum ParticleEffect { } /** - * Gets a List 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 - * @return A List of the players within the particle display range + * @return A List of Players within the particle display range */ private List getPlayersInRange(Location center) { List players = new ArrayList(); diff --git a/src/com/esophose/playerparticles/particles/ParticleGroup.java b/src/com/esophose/playerparticles/particles/ParticleGroup.java index a348d35..04af0be 100644 --- a/src/com/esophose/playerparticles/particles/ParticleGroup.java +++ b/src/com/esophose/playerparticles/particles/ParticleGroup.java @@ -26,7 +26,7 @@ public class ParticleGroup { } /** - * Get the List of particles in this group + * Get the List of ParticlePairs in this group * * @return The particles in this group */ diff --git a/src/com/esophose/playerparticles/particles/ParticlePair.java b/src/com/esophose/playerparticles/particles/ParticlePair.java index 99e964a..0fe082b 100644 --- a/src/com/esophose/playerparticles/particles/ParticlePair.java +++ b/src/com/esophose/playerparticles/particles/ParticlePair.java @@ -262,6 +262,7 @@ public class ParticlePair { /** * Gets a ParticlePair with the default values applied * + * @param ownerUUID The owner of this ParticlePair * @return A ParticlePair with default values */ @Deprecated // TODO: REMOVE ONCE NEW GUI IS DONE diff --git a/src/com/esophose/playerparticles/styles/api/ParticleStyle.java b/src/com/esophose/playerparticles/styles/api/ParticleStyle.java index 9535263..921764f 100644 --- a/src/com/esophose/playerparticles/styles/api/ParticleStyle.java +++ b/src/com/esophose/playerparticles/styles/api/ParticleStyle.java @@ -11,9 +11,9 @@ public interface ParticleStyle { /** * 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 - * @return A List of PParticles to spawn + * @return A List of PParticles to spawn */ public List getParticles(ParticlePair particle, Location location); diff --git a/src/com/esophose/playerparticles/styles/api/ParticleStyleManager.java b/src/com/esophose/playerparticles/styles/api/ParticleStyleManager.java index 3847cb0..c16b48b 100644 --- a/src/com/esophose/playerparticles/styles/api/ParticleStyleManager.java +++ b/src/com/esophose/playerparticles/styles/api/ParticleStyleManager.java @@ -52,7 +52,7 @@ public class ParticleStyleManager { /** * Gets all registered styles * - * @return A List of all registered styles + * @return A List of ParticleStyles that are registered */ public static List getStyles() { return styles;