1
0
mirror of https://github.com/MilkBowl/VaultAPI.git synced 2025-02-19 05:21:26 +01:00

fix some javadoc errors

This commit is contained in:
Nick Minkler 2014-05-17 10:36:19 -07:00
parent 7684863231
commit af25ed40b1
2 changed files with 27 additions and 2 deletions
src/main/java/net/milkbowl/vault

View File

@ -150,7 +150,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.
* @param playerName
* @param playerName name of the player
* @param world name of the world
* @return Amount currently held in players account
*/
@ -282,6 +282,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.
* @param playerName Name of player
* @param worldname Name of the world
* @param amount Amount to deposit
* @return Detailed response of transaction
*/
@ -409,6 +410,7 @@ public interface Economy {
* @deprecated As of Vault 1.3.01 use {{@link #createPlayerAccount(OfflinePlayer)} instead.
*
* Attempts to create a player account for the given player
* @param playerName name of the player
* @return if the account creation was successful
*/
@Deprecated
@ -416,6 +418,7 @@ public interface Economy {
/**
* Attempts to create a player account for the given player
* @param player OfflinePlayer
* @return if the account creation was successful
*/
public boolean createPlayerAccount(OfflinePlayer player);
@ -425,6 +428,8 @@ 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 the global balance will be returned.
* @param playerName String name of the player
* @param worldName String name of the world
* @return if the account creation was successful
*/
@Deprecated
@ -433,6 +438,8 @@ 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 the global balance will be returned.
* @param player OfflinePlayer
* @param worldName String name of the world
* @return if the account creation was successful
*/
public boolean createPlayerAccount(OfflinePlayer player, String worldName);

View File

@ -430,7 +430,7 @@ public abstract class Permission {
}
/**
* @deprecated As of Vault 1.3.01 use {{@link #playerRemoveTransient(OfflinePlayer, String)} instead
* @deprecated As of Vault 1.3.01 use {{@link #playerRemoveTransient(OfflinePlayer, String)} instead.
* 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
@ -449,6 +449,24 @@ public abstract class Permission {
return playerRemoveTransient(p, 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.
*
* @param player OfflinePlayer
* @param permission Permission node
* @return Success or Failure
*/
public boolean playerRemoveTransient(OfflinePlayer player, String permission) {
if (player.isOnline()) {
return playerRemoveTransient((Player) player, permission);
} else {
return false;
}
}
/**
* Remove transient permission from a player.
*