diff options
author | ElgarL <ElgarL@palmergames.com> | 2011-11-04 09:36:11 +0000 |
---|---|---|
committer | ElgarL <ElgarL@palmergames.com> | 2011-11-04 09:36:11 +0000 |
commit | 52c2110a2b7e8be079588e5abe2bd7b1a89546ef (patch) | |
tree | 31eebc02f3dd0f2438a415cfd0895094ad2401a7 /EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions | |
parent | 5560ab42940a50178a4588937f3b5cae7874e37f (diff) | |
download | Essentials-52c2110a2b7e8be079588e5abe2bd7b1a89546ef.tar Essentials-52c2110a2b7e8be079588e5abe2bd7b1a89546ef.tar.gz Essentials-52c2110a2b7e8be079588e5abe2bd7b1a89546ef.tar.lz Essentials-52c2110a2b7e8be079588e5abe2bd7b1a89546ef.tar.xz Essentials-52c2110a2b7e8be079588e5abe2bd7b1a89546ef.zip |
Fixed up javadoc comment errors
Diffstat (limited to 'EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions')
3 files changed, 93 insertions, 93 deletions
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/AnjoPermissionsHandler.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/AnjoPermissionsHandler.java index e8911b4a8..b858c2a6c 100644 --- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/AnjoPermissionsHandler.java +++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/AnjoPermissionsHandler.java @@ -46,7 +46,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param player * @param permission - * @return + * @return true if the player has the permission */ @Override public boolean has(Player player, String permission) { @@ -58,7 +58,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param player * @param permission - * @return + * @return true if the player has the permission */ @Override public boolean permission(Player player, String permission) { @@ -70,7 +70,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param playerName * @param permission - * @return + * @return true if the player has the permission */ public boolean permission(String playerName, String permission) { return checkUserPermission(ph.getUser(playerName), permission); @@ -80,7 +80,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * Returns the name of the group of that player name. * * @param userName - * @return + * @return String of players group name. */ @Override public String getGroup(String userName) { @@ -92,7 +92,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * player. * * @param userName - * @return + * @return List<String> of all players permissions. */ @Override public List<String> getAllPlayersPermissions(String userName) { @@ -139,19 +139,19 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { } /** - * Verify if player is in suck group. It will check it's groups inheritance. + * Verify if player is in such group. It will check it's groups inheritance. * * So if you have a group Admin > Moderator * * And verify the player 'MyAdmin', which is Admin, it will return true for * both Admin or Moderator groups. * - * Mas if you have a player 'MyModerator', which is Moderator, it will give + * If you have a player 'MyModerator', which is Moderator, it will give * false if you pass Admin in group parameter. * * @param name * @param group - * @return + * @return true if in group (with inheritance) */ @Override public boolean inGroup(String name, String group) { @@ -227,11 +227,8 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { /** * Check if user can build. Checks inheritance and subgroups. * - * @param world - * Player's world - * @param user - * Player's name - * @return Whether the user can build + * @param userName Player's name + * @return true if the user can build */ public boolean canUserBuild(String userName) { @@ -258,7 +255,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * Return the suffix for the given group name * * @param groupName - * @return + * @return empty string if not found. */ @Override public String getGroupSuffix(String groupName) { @@ -270,9 +267,11 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { } /** + * Checks the specified group for the Info Build node. + * Does NOT check inheritance * * @param groupName - * @return + * @return true if can build */ @Override public boolean canGroupBuild(String groupName) { @@ -372,7 +371,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param user * @param variable - * @return + * @return empty string if not found */ @Override public String getUserPermissionString(String user, String variable) { @@ -388,7 +387,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param user * @param variable - * @return + * @return -1 if not found */ @Override public int getUserPermissionInteger(String user, String variable) { @@ -404,7 +403,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param user * @param variable - * @return + * @return boolean value */ @Override public boolean getUserPermissionBoolean(String user, String variable) { @@ -420,7 +419,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param user * @param variable - * @return + * @return -1 if not found */ @Override public double getUserPermissionDouble(String user, String variable) { @@ -592,7 +591,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param user * @param permission - * @return + * @return PermissionCheckResult */ public PermissionCheckResult checkUserOnlyPermission(User user, String permission) { user.sortPermissions(); @@ -670,7 +669,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param user * @param targetPermission - * @return + * @return PermissionCheckResult */ public PermissionCheckResult checkFullUserPermission(User user, String targetPermission) { PermissionCheckResult result = new PermissionCheckResult(); @@ -851,7 +850,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * * @param start * @param targetPermission - * @return + * @return PermissionCheckResult */ public PermissionCheckResult checkGroupPermissionWithInheritance(Group start, String targetPermission) { if (start == null || targetPermission == null) { @@ -1016,7 +1015,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface { * Including subgroups. * * @param userName - * @return + * @return String[] of all group names. */ @Override public String[] getGroups(String userName) { diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/BukkitPermissions.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/BukkitPermissions.java index 9bc38f933..abfb73bfd 100644 --- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/BukkitPermissions.java +++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/BukkitPermissions.java @@ -187,7 +187,7 @@ public class BukkitPermissions { * null is empty
*
* @param node
- * @return
+ * @return Map of child permissions
*/
public Map<String, Boolean> getChildren(String node) {
for (Permission permission : registeredPermissions) {
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/PermissionsReaderInterface.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/PermissionsReaderInterface.java index bdad6f186..c0383c160 100644 --- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/PermissionsReaderInterface.java +++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/PermissionsReaderInterface.java @@ -16,6 +16,7 @@ import org.bukkit.entity.Player; * * @author Nijikokun * @author Gabriel Couto + * @author ElgarL */ public abstract class PermissionsReaderInterface { @@ -23,7 +24,7 @@ public abstract class PermissionsReaderInterface { * * @param player * @param string - * @return + * @return true if has permission */ public abstract boolean has(Player player, String string); @@ -31,141 +32,141 @@ public abstract class PermissionsReaderInterface { * * @param player * @param string - * @return + * @return true if has permission */ public abstract boolean permission(Player player, String string); /** * - * @param string - * @return + * @param userName + * @return group name for this player. */ - public abstract String getGroup(String string); + public abstract String getGroup(String userName); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param groupName + * @return true if in group */ - public abstract boolean inGroup(String string, String string1); + public abstract boolean inGroup(String userName, String groupName); /** * - * @param string - * @return + * @param groupName + * @return String of prefix */ - public abstract String getGroupPrefix(String string); + public abstract String getGroupPrefix(String groupName); /** * - * @param string - * @return + * @param groupName + * @return String of suffix */ - public abstract String getGroupSuffix(String string); + public abstract String getGroupSuffix(String groupName); /** * - * @param string - * @return + * @param groupName + * @return true if can build */ - public abstract boolean canGroupBuild(String string); + public abstract boolean canGroupBuild(String groupName); /** * - * @param string - * @param string1 - * @return + * @param groupName + * @param node + * @return String value */ - public abstract String getGroupPermissionString(String string, String string1); + public abstract String getGroupPermissionString(String groupName, String node); /** * - * @param string - * @param string1 - * @return + * @param groupName + * @param node + * @return integer value */ - public abstract int getGroupPermissionInteger(String string, String string1); + public abstract int getGroupPermissionInteger(String groupName, String node); /** * - * @param string - * @param string1 - * @return + * @param groupName + * @param node + * @return boolean value */ - public abstract boolean getGroupPermissionBoolean(String string, String string1); + public abstract boolean getGroupPermissionBoolean(String groupName, String node); /** * - * @param string - * @param string1 - * @return + * @param groupName + * @param node + * @return double value */ - public abstract double getGroupPermissionDouble(String string, String string1); + public abstract double getGroupPermissionDouble(String groupName, String node); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param node + * @return String value */ - public abstract String getUserPermissionString(String string, String string1); + public abstract String getUserPermissionString(String userName, String node); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param node + * @return integer value */ - public abstract int getUserPermissionInteger(String string, String string1); + public abstract int getUserPermissionInteger(String userName, String node); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param node + * @return boolean value */ - public abstract boolean getUserPermissionBoolean(String string, String string1); + public abstract boolean getUserPermissionBoolean(String userName, String node); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param node + * @return double value */ - public abstract double getUserPermissionDouble(String string, String string1); + public abstract double getUserPermissionDouble(String userName, String node); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param node + * @return String value */ - public abstract String getPermissionString(String string, String string1); + public abstract String getPermissionString(String userName, String node); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param node + * @return integer value */ - public abstract int getPermissionInteger(String string, String string1); + public abstract int getPermissionInteger(String userName, String node); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param node + * @return boolean value */ - public abstract boolean getPermissionBoolean(String string, String string1); + public abstract boolean getPermissionBoolean(String userName, String node); /** * - * @param string - * @param string1 - * @return + * @param userName + * @param node + * @return double value */ - public abstract double getPermissionDouble(String string, String string1); + public abstract double getPermissionDouble(String userName, String node); ///////////////////////////// /** @@ -173,7 +174,7 @@ public abstract class PermissionsReaderInterface { * This method is a utility method for chat plugins to get the user's prefix * without having to look at every one of the user's ancestors. * Returns an empty string if user has no parent groups. - * @param world Player's world + * * @param user Player's name * @return Player's prefix */ @@ -184,7 +185,7 @@ public abstract class PermissionsReaderInterface { * This method is a utility method for chat plugins to get the user's suffix * without having to look at every one of the user's ancestors. * Returns an empty string if user has no parent groups. - * @param world Player's world + * * @param user Player's name * @return Player's suffix */ @@ -215,7 +216,7 @@ public abstract class PermissionsReaderInterface { * @param entryName * @param path * @param isGroup - * @return + * @return -1 if not found */ public abstract double getInfoDouble(String entryName, String path, boolean isGroup); //public abstract double getInfoDouble(String entryName, String path, boolean isGroup, Comparator<Double> comparator); |