Pulling all pending Bukkit-JavaDoc changes

By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-04-02 00:11:22 -04:00
parent 745a0d7683
commit 761a84cb1b
93 changed files with 539 additions and 505 deletions

View File

@@ -96,7 +96,7 @@ public class Permission {
/**
* Sets the default value of this permission.
* <p />
* <p>
* This will not be saved to disk, and is a temporary operation until the server reloads permissions.
* Changing this default will cause all {@link Permissible}s that contain this permission to recalculate their permissions
*
@@ -122,7 +122,7 @@ public class Permission {
/**
* Sets the description of this permission.
* <p />
* <p>
* This will not be saved to disk, and is a temporary operation until the server reloads permissions.
*
* @param value The new description to set
@@ -137,7 +137,7 @@ public class Permission {
/**
* Gets a set containing every {@link Permissible} that has this permission.
* <p />
* <p>
* This set cannot be modified.
*
* @return Set containing permissibles with this permission
@@ -148,7 +148,7 @@ public class Permission {
/**
* Recalculates all {@link Permissible}s that contain this permission.
* <p />
* <p>
* This should be called after modifying the children, and is automatically called after modifying the default value
*/
public void recalculatePermissibles() {
@@ -163,7 +163,7 @@ public class Permission {
/**
* Adds this permission to the specified parent permission.
* <p />
* <p>
* If the parent permission does not exist, it will be created and registered.
*
* @param name Name of the parent permission
@@ -199,7 +199,7 @@ public class Permission {
/**
* Loads a list of Permissions from a map of data, usually used from retrieval from a yaml file.
* <p />
* <p>
* The data may contain a list of name:data, where the data contains the following keys:
* default: Boolean true or false. If not specified, false.
* children: Map<String, Boolean> of child permissions. If not specified, empty list.
@@ -226,7 +226,7 @@ public class Permission {
/**
* Loads a Permission from a map of data, usually used from retrieval from a yaml file.
* <p />
* <p>
* The data may contain the following keys:
* default: Boolean true or false. If not specified, false.
* children: Map<String, Boolean> of child permissions. If not specified, empty list.
@@ -242,7 +242,7 @@ public class Permission {
/**
* Loads a Permission from a map of data, usually used from retrieval from a yaml file.
* <p />
* <p>
* The data may contain the following keys:
* default: Boolean true or false. If not specified, false.
* children: Map<String, Boolean> of child permissions. If not specified, empty list.