Code comments

11 files changed, 15 insertions, 6 deletions

diff --git a/Essentials/src/com/earth2me/essentials/EssentialsEntityListener.java b/Essentials/src/com/earth2me/essentials/EssentialsEntityListener.java
index 0077d988c..693bde3ef 100644
--- a/Essentials/src/com/earth2me/essentials/EssentialsEntityListener.java
+++ b/Essentials/src/com/earth2me/essentials/EssentialsEntityListener.java
@@ -27,6 +27,7 @@ public class EssentialsEntityListener implements Listener
 		this.ess = ess;
 	}
 
+	// This method does something undocumented reguarding certain bucket types #EasterEgg
 	@EventHandler(priority = EventPriority.LOW)
 	public void onEntityDamage(final EntityDamageByEntityEvent event)
 	{
diff --git a/Essentials/src/com/earth2me/essentials/EssentialsPlayerListener.java b/Essentials/src/com/earth2me/essentials/EssentialsPlayerListener.java
index 8ef218a67..2b5693c8d 100644
--- a/Essentials/src/com/earth2me/essentials/EssentialsPlayerListener.java
+++ b/Essentials/src/com/earth2me/essentials/EssentialsPlayerListener.java
@@ -414,6 +414,7 @@ public class EssentialsPlayerListener implements Listener
 		}
 	}
 
+	// This method allows the /jump lock feature to work, allows teleporting while flying #EasterEgg
 	private void useFlyClickJump(final User user)
 	{
 		try
diff --git a/Essentials/src/com/earth2me/essentials/Settings.java b/Essentials/src/com/earth2me/essentials/Settings.java
index fff129d52..f05474196 100644
--- a/Essentials/src/com/earth2me/essentials/Settings.java
+++ b/Essentials/src/com/earth2me/essentials/Settings.java
@@ -928,6 +928,8 @@ public class Settings implements ISettings
 		return maxSpeed > 1.0 ? 1.0 : Math.abs(maxSpeed);
 	}
 
+	//This option does not exist in the config.yml because it wasn't yet implemented in bukkit
+	//The code was commented out in the /speed command
 	@Override
 	public double getMaxWalkSpeed()
 	{
diff --git a/Essentials/src/com/earth2me/essentials/Trade.java b/Essentials/src/com/earth2me/essentials/Trade.java
index ff37a5d28..420525e63 100644
--- a/Essentials/src/com/earth2me/essentials/Trade.java
+++ b/Essentials/src/com/earth2me/essentials/Trade.java
@@ -234,6 +234,9 @@ public class Trade
 
 	public static void log(String type, String subtype, String event, String sender, Trade charge, String receiver, Trade pay, Location loc, IEssentials ess)
 	{
+		//isEcoLogUpdateEnabled() - This refers to log entries with no location, ie API updates #EasterEgg
+		//isEcoLogEnabled() - This refers to log entries with with location, ie /pay /sell and eco signs.
+		
 		if ((loc == null && !ess.getSettings().isEcoLogUpdateEnabled())
 			|| (loc != null && !ess.getSettings().isEcoLogEnabled()))
 		{
diff --git a/Essentials/src/com/earth2me/essentials/User.java b/Essentials/src/com/earth2me/essentials/User.java
index 01284d4b8..f74e11f25 100644
--- a/Essentials/src/com/earth2me/essentials/User.java
+++ b/Essentials/src/com/earth2me/essentials/User.java
@@ -306,6 +306,7 @@ public class User extends UserData implements Comparable<User>, IReplyTo, IUser
 
 		if (ess.getSettings().addPrefixSuffix())
 		{
+			//These two extra toggles are not documented, because they are mostly redundant #EasterEgg
 			if (!ess.getSettings().disablePrefix())
 			{
 				final String ptext = ess.getPermissionsHandler().getPrefix(base).replace('&', '§');
diff --git a/Essentials/src/com/earth2me/essentials/commands/Commandantioch.java b/Essentials/src/com/earth2me/essentials/commands/Commandantioch.java
index 968d0012c..79ef1f969 100644
--- a/Essentials/src/com/earth2me/essentials/commands/Commandantioch.java
+++ b/Essentials/src/com/earth2me/essentials/commands/Commandantioch.java
@@ -6,7 +6,7 @@ import org.bukkit.Location;
 import org.bukkit.Server;
 import org.bukkit.entity.TNTPrimed;
 
-
+// This command has a in theme message that only shows if you supply a parameter #EasterEgg
 public class Commandantioch extends EssentialsCommand
 {
 	public Commandantioch()
diff --git a/Essentials/src/com/earth2me/essentials/commands/Commandessentials.java b/Essentials/src/com/earth2me/essentials/commands/Commandessentials.java
index fe33aebd7..8598a31e9 100644
--- a/Essentials/src/com/earth2me/essentials/commands/Commandessentials.java
+++ b/Essentials/src/com/earth2me/essentials/commands/Commandessentials.java
@@ -14,7 +14,7 @@ import org.bukkit.command.CommandSender;
 import org.bukkit.command.ConsoleCommandSender;
 import org.bukkit.entity.Player;
 
-
+// This command has 4 undocumented behaviours #EasterEgg
 public class Commandessentials extends EssentialsCommand
 {
 	public Commandessentials()
@@ -55,6 +55,7 @@ public class Commandessentials extends EssentialsCommand
 		}
 	}
 	
+	//If you do not supply an argument this command will list 'overridden' commands.
 	private void run_disabled(final Server server, final CommandSender sender, final String commandLabel, final String[] args) throws Exception
 	{
 		sender.sendMessage("Essentials " + ess.getDescription().getVersion());
diff --git a/Essentials/src/com/earth2me/essentials/commands/Commandjump.java b/Essentials/src/com/earth2me/essentials/commands/Commandjump.java
index ba7182628..073c20dce 100644
--- a/Essentials/src/com/earth2me/essentials/commands/Commandjump.java
+++ b/Essentials/src/com/earth2me/essentials/commands/Commandjump.java
@@ -8,7 +8,7 @@ import org.bukkit.Location;
 import org.bukkit.Server;
 import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause;
 
-
+// This method contains an undocumented sub command #EasterEgg
 public class Commandjump extends EssentialsCommand
 {
 	public Commandjump()
diff --git a/Essentials/src/com/earth2me/essentials/commands/Commandkittycannon.java b/Essentials/src/com/earth2me/essentials/commands/Commandkittycannon.java
index 9db608235..a94f09cdb 100644
--- a/Essentials/src/com/earth2me/essentials/commands/Commandkittycannon.java
+++ b/Essentials/src/com/earth2me/essentials/commands/Commandkittycannon.java
@@ -7,7 +7,7 @@ import org.bukkit.Location;
 import org.bukkit.Server;
 import org.bukkit.entity.Ocelot;
 
-
+// This command is not documented on the wiki #EasterEgg
 public class Commandkittycannon extends EssentialsCommand
 {
 	private static Random random = new Random();
diff --git a/Essentials/src/com/earth2me/essentials/commands/Commandping.java b/Essentials/src/com/earth2me/essentials/commands/Commandping.java
index 43aa18d5f..0b1df5bf5 100644
--- a/Essentials/src/com/earth2me/essentials/commands/Commandping.java
+++ b/Essentials/src/com/earth2me/essentials/commands/Commandping.java
@@ -5,7 +5,7 @@ import com.earth2me.essentials.Util;
 import org.bukkit.Server;
 import org.bukkit.command.CommandSender;
 
-
+// This command can be used to echo messages to the users screen, mostly useless but also an #EasterEgg
 public class Commandping extends EssentialsCommand
 {
 	public Commandping()
diff --git a/Essentials/src/com/earth2me/essentials/signs/SignProtection.java b/Essentials/src/com/earth2me/essentials/signs/SignProtection.java
index 6fdf056e2..1ea26c859 100644
--- a/Essentials/src/com/earth2me/essentials/signs/SignProtection.java
+++ b/Essentials/src/com/earth2me/essentials/signs/SignProtection.java
@@ -10,7 +10,7 @@ import org.bukkit.block.BlockFace;
 import org.bukkit.block.Sign;
 import org.bukkit.inventory.ItemStack;
 
-
+@Deprecated // This sign will be removed soon
 public class SignProtection extends EssentialsSign
 {
 	private final transient Set<Material> protectedBlocks = EnumSet.noneOf(Material.class);