Pulling all pending Bukkit-JavaDoc changes

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
@@ -5,21 +5,26 @@ import org.bukkit.plugin.Plugin;
import java.util.concurrent.Callable;
/**
* A FixedMetadataValue is a special case metadata item that contains the same value forever after initialization.
* Invalidating a FixedMetadataValue has no effect.
* A FixedMetadataValue is a special case metadata item that contains the same
* value forever after initialization. Invalidating a FixedMetadataValue has
* no effect.
* <p>
* This class extends LazyMetadataValue for historical reasons, even though it overrides all the implementation
* methods. it is possible that in the future that the inheritance hierarchy may change.
* This class extends LazyMetadataValue for historical reasons, even though it
* overrides all the implementation methods. it is possible that in the future
* that the inheritance hierarchy may change.
*/
public class FixedMetadataValue extends LazyMetadataValue {
/** Store the internal value that is represented by this fixed value. */
/**
* Store the internal value that is represented by this fixed value.
*/
private final Object internalValue;
/**
* Initializes a FixedMetadataValue with an Object
*
* @param owningPlugin the {@link Plugin} that created this metadata value.
* @param value the value assigned to this metadata value.
* @param owningPlugin the {@link Plugin} that created this metadata value
* @param value the value assigned to this metadata value
*/
public FixedMetadataValue(Plugin owningPlugin, final Object value) {
super(owningPlugin);