SpigotMC/Saber-Factions
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed all javadoc errors and regenerated them.

Browse Source
This commit is contained in:
ProSavage
2018-11-19 01:34:29 -06:00
parent ff6a3b2b1a
commit 7a59ad4a66
344 changed files with 3093 additions and 2184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/com/massivecraft/factions/Board.java
View File

@@ -76,7 +76,7 @@ public abstract class Board {
// Map generation
//----------------------------------------------//
/**
/*
* The map is relative to a coord and a faction north is in the direction of decreasing x east is in the direction
* of decreasing z
*/

6
src/main/java/com/massivecraft/factions/FPlayer.java
View File

@@ -19,9 +19,7 @@ import java.util.List;
* Logged in players always have exactly one FPlayer instance. Logged out players may or may not have an FPlayer
* instance. They will always have one if they are part of a faction. This is because only players with a faction are
* saved to disk (in order to not waste disk space).
* <plugin/>
* The FPlayer is linked to a minecraft player using the player name.
* <plugin/>
* The same instance is always returned for the same player. This means you can use the == operator. No .equals method
* necessary.
*/
@@ -38,7 +36,7 @@ public interface FPlayer extends EconomyParticipator {
/**
* Toggles the stealth of the FPlayer depending on the parameter
*
* @param stealthToggle
* @param stealthToggle - toggles stealth
*/
void setStealth(boolean stealthToggle);
@@ -62,7 +60,7 @@ public interface FPlayer extends EconomyParticipator {
/**
* Sets the faction of the FPlayer
*
* @param faction
* @param faction faction to set.
*/
void setFaction(Faction faction);

2
src/main/java/com/massivecraft/factions/listeners/FactionsEntityListener.java
View File

@@ -776,4 +776,4 @@ public class FactionsEntityListener implements Listener {
return false;
}
}
}

31
src/main/java/com/massivecraft/factions/util/Particles/ParticleEffect.java
View File

@@ -19,15 +19,13 @@ import java.util.Map.Entry;
/**
* <b>ParticleEffect Library</b>
* <plugin>
* This library was created by @DarkBlade12 and allows you to display all Minecraft particle effects on a Bukkit server
* <plugin>
*
* You are welcome to use it, modify it and redistribute it under the following conditions:
* <ul>
* <li>Don't claim this class as your own
* <li>Don't remove this disclaimer
* </ul>
* <plugin>
* Special thanks:
* <ul>
* <li>@microgeek (original idea, names and packet parameters)
@@ -36,7 +34,6 @@ import java.util.Map.Entry;
* <li>@Cybermaxke (particle behavior)
* <li>@JamieSinn (hosting a jenkins server and documentation for particleeffect)
* </ul>
* <plugin>
* <i>It would be nice if you provide credit to me if you use this class in a published project</i>
*
* @author DarkBlade12
@@ -527,6 +524,8 @@ public enum ParticleEffect {
/**
* Determine if this particle effect has a specific property
*
*
* @param property - property to check.
* @return Whether it has the property or not
*/
public boolean hasProperty(ParticleProperty property) {
@@ -905,7 +904,6 @@ public enum ParticleEffect {
/**
* Represents the property of a particle effect
* <plugin>
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -932,7 +930,6 @@ public enum ParticleEffect {
/**
* Represents the particle data for effects like {@link ParticleEffect#ITEM_CRACK}, {@link ParticleEffect#BLOCK_CRACK} and {@link ParticleEffect#BLOCK_DUST}
* <plugin>
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -995,7 +992,6 @@ public enum ParticleEffect {
/**
* Represents the item data for the {@link ParticleEffect#ITEM_CRACK} effect
* <plugin>
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1016,7 +1012,6 @@ public enum ParticleEffect {
/**
* Represents the block data for the {@link ParticleEffect#BLOCK_CRACK} and {@link ParticleEffect#BLOCK_DUST} effects
* <plugin>
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1041,7 +1036,6 @@ public enum ParticleEffect {
/**
* Represents the color for effects like {@link ParticleEffect#SPELL_MOB}, {@link ParticleEffect#SPELL_MOB_AMBIENT}, {@link ParticleEffect#REDSTONE} and {@link ParticleEffect#NOTE}
* <plugin>
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1072,7 +1066,6 @@ public enum ParticleEffect {
/**
* Represents the color for effects like {@link ParticleEffect#SPELL_MOB}, {@link ParticleEffect#SPELL_MOB_AMBIENT} and {@link ParticleEffect#NOTE}
* <plugin>
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1184,7 +1177,7 @@ public enum ParticleEffect {
/**
* Represents the color for the {@link ParticleEffect#NOTE} effect
* <plugin>
*
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1243,7 +1236,7 @@ public enum ParticleEffect {
/**
* Represents a runtime exception that is thrown either if the displayed particle effect requires data and has none or vice-versa or if the data type is incorrect
* <plugin>
*
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1264,7 +1257,7 @@ public enum ParticleEffect {
/**
* Represents a runtime exception that is thrown either if the displayed particle effect is not colorable or if the particle color type is incorrect
* <plugin>
*
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1285,7 +1278,7 @@ public enum ParticleEffect {
/**
* Represents a runtime exception that is thrown if the displayed particle effect requires a newer version
* <plugin>
*
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1306,7 +1299,7 @@ public enum ParticleEffect {
/**
* Represents a particle effect packet with all attributes which is used for sending packets to the players
* <plugin>
*
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1392,7 +1385,7 @@ public enum ParticleEffect {
/**
* Initializes {@link #packetConstructor}, {@link #getHandle}, {@link #playerConnection} and {@link #sendPacket} and sets {@link #initialized} to <code>true</code> if it succeeds
* <plugin>
*
* <b>Note:</b> These fields only have to be initialized once, so it will return if {@link #initialized} is already set to <code>true</code>
*
* @throws VersionIncompatibleException if your bukkit version is not supported by this library
@@ -1539,7 +1532,7 @@ public enum ParticleEffect {
/**
* Represents a runtime exception that is thrown if a bukkit version is not compatible with this library
* <plugin>
*
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1561,7 +1554,7 @@ public enum ParticleEffect {
/**
* Represents a runtime exception that is thrown if packet instantiation fails
* <plugin>
*
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -1583,7 +1576,7 @@ public enum ParticleEffect {
/**
* Represents a runtime exception that is thrown if packet sending fails
* <plugin>
*
* This class is part of the <b>ParticleEffect Library</b> and follows the same usage conditions
*
* @author DarkBlade12

10
src/main/java/com/massivecraft/factions/util/Particles/ReflectionUtils.java
View File

@@ -11,15 +11,15 @@ import java.util.Map;
/**
* <b>ReflectionUtils</b>
* <plugin>
*
* This class provides useful methods which makes dealing with reflection much easier, especially when working with Bukkit
* <plugin>
*
* You are welcome to use it, modify it and redistribute it under the following conditions:
* <ul>
* <li>Don't claim this class as your own
* <li>Don't remove this disclaimer
* </ul>
* <plugin>
*
* <i>It would be nice if you provide credit to me if you use this class in a published project</i>
*
* @author DarkBlade12
@@ -346,7 +346,7 @@ public final class ReflectionUtils {
/**
* Represents an enumeration of dynamic packages of NMS and CraftBukkit
* <plugin>
*
* This class is part of the <b>ReflectionUtils</b> and follows the same usage conditions
*
* @author DarkBlade12
@@ -433,7 +433,7 @@ public final class ReflectionUtils {
/**
* Represents an enumeration of Java data types with corresponding classes
* <plugin>
*
* This class is part of the <b>ReflectionUtils</b> and follows the same usage conditions
*
* @author DarkBlade12

2
src/main/java/com/massivecraft/factions/util/WarmUpUtil.java
View File

@@ -12,7 +12,7 @@ public class WarmUpUtil {
* @param action The action, inserted into the notification message.
* @param runnable The task to run after the delay. If the delay is 0, the task is instantly ran.
* @param delay The time used, in seconds, for the delay.
* <plugin/>
*
* note: for translations: %s = action, %d = delay
*/
public static void process(final FPlayer player, Warmup warmup, TL translationKey, String action, final Runnable runnable, long delay) {

2
src/main/java/com/massivecraft/factions/zcore/persist/MemoryFPlayer.java
View File

@@ -38,9 +38,7 @@ import java.util.UUID;
* Logged in players always have exactly one FPlayer instance. Logged out players may or may not have an FPlayer
* instance. They will always have one if they are part of a faction. This is because only players with a faction are
* saved to disk (in order to not waste disk space).
* <plugin/>
* The FPlayer is linked to a minecraft player using the player name.
* <plugin/>
* The same instance is always returned for the same player. This means you can use the == operator. No .equals method
* necessary.
*/