Fix typos and formatting in JavaDoc comments

Author: NonSwag

src/main/java/net/milkbowl/vault/chat/Chat.java

@@ -705,8 +705,8 @@ public void setPlayerInfoBoolean(Player player, String node, boolean value) {
     /**
      * Get a groups informational node (Boolean) value
      *
-     * @param world        Name of World
-     * @param group        Name of Group
+     * @param world        Name of the world
+     * @param group        Name of the group
      * @param node         Permission node
      * @param defaultValue Default value
      * @return Value
@@ -850,8 +850,8 @@ public void setPlayerInfoString(Player player, String node, String value) {
     /**
      * Get a groups informational node (String) value
      *
-     * @param world        Name of World
-     * @param group        Name of Group
+     * @param world        Name of the world
+     * @param group        Name of the group
      * @param node         Permission node
      * @param defaultValue Default value
      * @return Value
@@ -911,7 +911,7 @@ public boolean playerInGroup(@Nullable String world, OfflinePlayer player, Strin
      * @param group  Group name
      * @return Success or Failure
      * @deprecated As of VaultAPI 1.4 use {@link #playerInGroup(String, OfflinePlayer, String)} instead.
-     * Check if player is member of a group.
+     * Check if the player is a member of a group.
      */
     @Deprecated(since = "1.4")
     public boolean playerInGroup(@Nullable String world, String player, String group) {
@@ -924,7 +924,7 @@ public boolean playerInGroup(@Nullable String world, String player, String group
      * @param group  Group name
      * @return Success or Failure
      * @deprecated As of VaultAPI 1.4 use {@link #playerInGroup(String, OfflinePlayer, String)} instead.
-     * Check if player is member of a group.
+     * Check if the player is a member of a group.
      */
     @Deprecated(since = "1.4")
     public boolean playerInGroup(@Nullable World world, String player, String group) {

src/main/java/net/milkbowl/vault/economy/Economy.java

@@ -57,17 +57,17 @@ public interface Economy {
     int fractionalDigits();
 
     /**
-     * Format amount into a human readable String This provides translation into
+     * Format amount into a human-readable String This provides translation into
      * economy specific formatting to improve consistency between plugins.
      *
      * @param amount to format
-     * @return Human readable string describing amount
+     * @return Human-readable string describing amount
      */
     String format(double amount);
 
     /**
      * Returns the name of the currency in plural form.
-     * If the economy being used does not support currency names then an empty string will be returned.
+     * If the economy being used does not support currency names, then an empty string will be returned.
      *
      * @return name of the currency (plural)
      */
@@ -76,7 +76,7 @@ public interface Economy {
 
     /**
      * Returns the name of the currency in singular form.
-     * If the economy being used does not support currency names then an empty string will be returned.
+     * If the economy being used does not support currency names, then an empty string will be returned.
      *
      * @return name of the currency (singular)
      */
@@ -90,9 +90,9 @@ public interface Economy {
     boolean hasAccount(String playerName);
 
     /**
-     * Checks if this player has an account on the server yet
-     * This will always return true if the player has joined the server at least once
-     * as all major economy plugins auto-generate a player account when the player joins the server
+     * Checks if this player has an account on the server, yet.
+     * This will always return true if the player has joined the server at least once 
+     * as all major economy plugins auto-generate a player account when the player joins the server.
      *
      * @param player to check
      * @return if the player has an account
@@ -106,9 +106,9 @@ public interface Economy {
     boolean hasAccount(String playerName, @Nullable String worldName);
 
     /**
-     * Checks if this player has an account on the server yet on the given world
+     * Checks if this player has an account on the server yet on the given world.
      * This will always return true if the player has joined the server at least once
-     * as all major economy plugins auto-generate a player account when the player joins the server
+     * as all major economy plugins auto-generate a player account when the player joins the server.
      *
      * @param player    to check in the world
      * @param worldName world-specific account
@@ -138,7 +138,7 @@ public interface Economy {
 
     /**
      * Gets balance of a player on the specified world.
-     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
+     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this, the global balance will be returned.
      *
      * @param player to check
      * @param world  name of the world
@@ -169,7 +169,7 @@ public interface Economy {
 
     /**
      * Checks if the player account has the amount in a given world - DO NOT USE NEGATIVE AMOUNTS
-     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
+     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this, the global balance will be returned.
      *
      * @param player    to check
      * @param worldName to check with
@@ -201,7 +201,7 @@ public interface Economy {
 
     /**
      * Withdraw an amount from a player on a given world - DO NOT USE NEGATIVE AMOUNTS
-     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
+     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this, the global balance will be returned.
      *
      * @param player    to withdraw from
      * @param worldName - name of the world
@@ -233,7 +233,7 @@ public interface Economy {
 
     /**
      * Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS
-     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
+     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this, the global balance will be returned.
      *
      * @param player    to deposit to
      * @param worldName name of the world
@@ -359,7 +359,7 @@ public interface Economy {
 
     /**
      * Attempts to create a player account for the given player on the specified world
-     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this then false will always be returned.
+     * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this, then false will always be returned.
      *
      * @param player    OfflinePlayer
      * @param worldName String name of the world

src/main/java/net/milkbowl/vault/economy/EconomyResponse.java

@@ -37,7 +37,7 @@ public class EconomyResponse {
      */
     public final ResponseType type;
     /**
-     * Error message if the variable 'type' is ResponseType.FAILURE
+     * Error message if the variable 'type' is {@link ResponseType#FAILURE}
      */
     public final @Nullable String errorMessage;
 

src/main/java/net/milkbowl/vault/permission/Permission.java

@@ -73,10 +73,10 @@ public boolean has(@Nullable World world, String player, String permission) {
 
     /**
      * Checks if a CommandSender has a permission node.
-     * This will return the result of bukkits, generic .hasPermission() method and is identical in all cases.
+     * This will return the result of bukkit's, generic .hasPermission() method and is identical in all cases.
      * This method will explicitly fail if the registered permission system does not register permissions in bukkit.
      * <p>
-     * For easy checking of a commandsender
+     * For easy checking of a command sender
      *
      * @param sender     to check permissions on
      * @param permission to check for
@@ -175,7 +175,8 @@ public boolean playerAdd(@Nullable String world, OfflinePlayer player, String pe
 
     /**
      * Add permission to a player ONLY for the world the player is currently on.
-     * This is a world-specific operation, if you want to add global permission you must explicitly use NULL for the world.
+     * This is a world-specific operation, if you want to add global permission,
+     * you must explicitly use NULL for the world.
      * See {@link #playerAdd(String, OfflinePlayer, String)} for global permission use.
      *
      * @param player     Player Object
@@ -310,7 +311,8 @@ public boolean playerRemove(@Nullable World world, String player, String permiss
 
     /**
      * Remove permission from a player.
-     * Will attempt to remove permission from the player on the player's current world.  This is NOT a global operation.
+     * Will attempt to remove permission from the player in the player's current world.
+     * This is NOT a global operation.
      *
      * @param player     Player Object
      * @param permission Permission node
@@ -324,8 +326,8 @@ public boolean playerRemove(Player player, String permission) {
     /**
      * Remove transient permission from a player.
      * This implementation can be used by any subclass which implements a "pure" superperms plugin, i.e.
-     * one that only needs the built-in Bukkit API to remove transient permissions from a player.  Any subclass
-     * implementing a plugin which provides its own API for this needs to override this method.
+     * one that only needs the built-in Bukkit API to remove transient permissions from a player.
+     * Any subclass implementing a plugin which provides its own API for these needs to override this method.
      *
      * @param player     OfflinePlayer
      * @param permission Permission node
@@ -461,7 +463,7 @@ public boolean playerInGroup(@Nullable String world, OfflinePlayer player, Strin
     /**
      * Check if player is member of a group.
      * This method will ONLY check groups for which the player is in that are defined for the current world.
-     * This may result in odd return behaviour depending on what permission system has been registered.
+     * This may result in odd return behavior depending on what permission system has been registered.
      *
      * @param player Player Object
      * @param group  Group name
@@ -501,8 +503,9 @@ public boolean playerAddGroup(@Nullable String world, OfflinePlayer player, Stri
 
     /**
      * Add player to a group.
-     * This will add a player to the group on the current World.  This may return odd results if the permission system
-     * being used on the server does not support world-specific groups, or if the group being added to is a global group.
+     * This will add a player to the group in the current World.
+     * This may return odd results if the permission system being used on the server does not support world-specific groups,
+     * or if the group being added to is a global group.
      *
      * @param player Player Object
      * @param group  Group name
@@ -542,8 +545,9 @@ public boolean playerRemoveGroup(@Nullable String world, OfflinePlayer player, S
 
     /**
      * Remove player from a group.
-     * This will add a player to the group on the current World.  This may return odd results if the permission system
-     * being used on the server does not support world-specific groups, or if the group being added to is a global group.
+     * This will add a player to the group in the current World.
+     * This may return odd results if the permission system being used on the server does not support world-specific groups,
+     * or if the group being added to is a global group.
      *
      * @param player Player Object
      * @param group  Group name