SteamWar/Paper
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
A special thanks goes to @aerouk for almost all of the changes found here.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
paper-api/src/main/java/org/bukkit/permissions/PermissionAttachment.java
View File

@@ -5,7 +5,8 @@ import java.util.Map;
import org.bukkit.plugin.Plugin;
/**
* Holds information about a permission attachment on a {@link Permissible} object
* Holds information about a permission attachment on a {@link Permissible}
* object
*/
public class PermissionAttachment {
private PermissionRemovedExecutor removed;
@@ -34,7 +35,8 @@ public class PermissionAttachment {
}
/**
* Sets an object to be called for when this attachment is removed from a {@link Permissible}. May be null.
* Sets an object to be called for when this attachment is removed from a
* {@link Permissible}. May be null.
*
* @param ex Object to be called when this is removed
*/
@@ -43,7 +45,8 @@ public class PermissionAttachment {
}
/**
* Gets the class that was previously set to be called when this attachment was removed from a {@link Permissible}. May be null.
* Gets the class that was previously set to be called when this
* attachment was removed from a {@link Permissible}. May be null.
*
* @return Object to be called when this is removed
*/
@@ -61,9 +64,11 @@ public class PermissionAttachment {
}
/**
* Gets a copy of all set permissions and values contained within this attachment.
* Gets a copy of all set permissions and values contained within this
* attachment.
* <p>
* This map may be modified but will not affect the attachment, as it is a copy.
* This map may be modified but will not affect the attachment, as it is a
* copy.
*
* @return Copy of all permissions and values expressed by this attachment
*/
@@ -95,7 +100,8 @@ public class PermissionAttachment {
/**
* Removes the specified permission from this attachment.
* <p>
* If the permission does not exist in this attachment, nothing will happen.
* If the permission does not exist in this attachment, nothing will
* happen.
*
* @param name Name of the permission to remove
*/
@@ -107,7 +113,8 @@ public class PermissionAttachment {
/**
* Removes the specified permission from this attachment.
* <p>
* If the permission does not exist in this attachment, nothing will happen.
* If the permission does not exist in this attachment, nothing will
* happen.
*
* @param perm Permission to remove
*/
@@ -118,7 +125,8 @@ public class PermissionAttachment {
/**
* Removes this attachment from its registered {@link Permissible}
*
* @return true if the permissible was removed successfully, false if it did not exist
* @return true if the permissible was removed successfully, false if it
* did not exist
*/
public boolean remove() {
try {