Fixed JavaDoc

Author: Programie

src/main/java/net/minearea/talkingmobs/EventListener.java

@@ -8,11 +8,19 @@
 import org.bukkit.event.entity.EntityDamageByEntityEvent;
 import org.bukkit.event.entity.EntityDeathEvent;
 
+/**
+ * Class providing all event listeners required for the plugin
+ */
 public class EventListener implements Listener
 {
 	private final TalkingMobs plugin;
 	private final Message message;
 
+	/**
+	 * Constructor of the class
+	 * @param pluginInstance The instance of this plugin (Instance of the TalkingMobs class)
+	 * @param messageInstance The instance of the Message class
+	 */
 	public EventListener(TalkingMobs pluginInstance, Message messageInstance)
 	{
 		plugin = pluginInstance;
@@ -31,6 +39,7 @@ public void onEntityAttacked(EntityDamageByEntityEvent event)
 	{
 		Entity damager = event.getDamager();
 		Entity entity = event.getEntity();
+
 		if (damager instanceof Player && !entity.isDead())
 		{
 			message.sendMessage(entity, (Player) damager, Message.EventType.attacked);

src/main/java/net/minearea/talkingmobs/Message.java

@@ -8,7 +8,7 @@
 import org.bukkit.entity.Player;
 
 /**
- * Class to send mob messages to players
+ * Class providing methods to send mob messages to players
  */
 public class Message
 {
@@ -50,6 +50,12 @@ public Message(TalkingMobs pluginInstance)
 		plugin = pluginInstance;
 	}
 
+	/**
+	 * Get a random message for the specified mob and event type
+	 * @param mob The entity of the mob for which the message should be fetched
+	 * @param eventType The event type of the message
+	 * @return A string containing the message
+	 */
 	private String getMessage(Entity mob, EventType eventType)
 	{
 		List<String> messages;
@@ -75,6 +81,11 @@ private String getMessage(Entity mob, EventType eventType)
 		return null;
 	}
 
+	/**
+	 * Check whether the player has the permission to receive mob messages
+	 * @param player The player which should be checked
+	 * @return True if the player has the permission, false otherwise
+	 */
 	private boolean isAllowed(Player player)
 	{
 		return player.hasPermission("talkingmobs.receive");
@@ -109,6 +120,12 @@ public boolean isEnabled(Player player)
 		return plugin.getConfig().getBoolean("players." + player.getName() + ".enabled.all", true);
 	}
 
+	/**
+	 * Format the message and send it to the player
+	 * Formatting includes replacing %player% with the name of the player and translating color codes.
+	 * @param player The player which should receive the message
+	 * @param message The message to send
+	 */
 	private void sendFormattedMessage(Player player, String message)
 	{
 		String formattedMessage = message.replaceAll("%player%", player.getName());
@@ -120,7 +137,7 @@ private void sendFormattedMessage(Player player, String message)
 	 * Send a mob message to the player
 	 * @param mob The mob which sends the message
 	 * @param player The player which should receive the message
-	 * @param messageType The type of the message
+	 * @param eventType The event type
 	 */
 	public void sendMessage(Entity mob, Player player, EventType eventType)
 	{
@@ -137,7 +154,7 @@ public void sendMessage(Entity mob, Player player, EventType eventType)
 	/**
 	 * Send a mob message to all players
 	 * @param mob The mob which sends the message
-	 * @param messageType The type of the message
+	 * @param eventType The event type
 	 */
 	public void sendMessage(Entity mob, EventType eventType)
 	{

src/main/java/net/minearea/talkingmobs/TalkingMobs.java

@@ -44,7 +44,7 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 							eventTypes.add(eventType.toString());
 						}
 
-						sender.sendMessage("/talkingmobs toggle <type> - Toggle messages send by mobs (Type is optional and can be used to only toggle the specified message type)");
+						sender.sendMessage("/talkingmobs toggle <type> - Toggle messages sent by mobs (Type is optional and can be used to only toggle the specified message type)");
 						sender.sendMessage("");
 						sender.sendMessage("Message types: " + StringUtils.join(eventTypes, ", "));
 
@@ -60,6 +60,7 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 						{
 							sender.sendMessage(ChatColor.RED + "You do not have the required permissions for this command!");
 						}
+
 						return true;
 					case "toggle":
 						if (sender instanceof Player)
@@ -106,10 +107,12 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 						{
 							sender.sendMessage(ChatColor.RED + "This command can only be run by a player!");
 						}
+
 						return true;
 				}
 			}
 		}
+
 		return false;
 	}
 }