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

@@ -4,7 +4,7 @@ import java.util.Map;
/**
* Represents an object that may be serialized.
* <p />
* <p>
* These objects MUST implement one of the following, in addition to the methods
* as defined by this interface:
* <ul>
@@ -22,7 +22,7 @@ import java.util.Map;
public interface ConfigurationSerializable {
/**
* Creates a Map representation of this class.
* <p />
* <p>
* This class must provide a method to restore this class, as defined in the
* {@link ConfigurationSerializable} interface javadocs.
*

View File

@@ -135,10 +135,10 @@ public class ConfigurationSerialization {
/**
* Attempts to deserialize the given arguments into a new instance of the given class.
* <p />
* <p>
* The class must implement {@link ConfigurationSerializable}, including the extra methods
* as specified in the javadoc of ConfigurationSerializable.
* <p />
* <p>
* If a new instance could not be made, an example being the class not fully implementing
* the interface, null will be returned.
*
@@ -152,10 +152,10 @@ public class ConfigurationSerialization {
/**
* Attempts to deserialize the given arguments into a new instance of the given class.
* <p />
* <p>
* The class must implement {@link ConfigurationSerializable}, including the extra methods
* as specified in the javadoc of ConfigurationSerializable.
* <p />
* <p>
* If a new instance could not be made, an example being the class not fully implementing
* the interface, null will be returned.
*

View File

@@ -9,10 +9,10 @@ import java.lang.annotation.Target;
* Represents an "alias" that a {@link ConfigurationSerializable} may be stored as.
* If this is not present on a {@link ConfigurationSerializable} class, it will use the
* fully qualified name of the class.
* <p />
* <p>
* This value will be stored in the configuration so that the configuration deserialization
* can determine what type it is.
* <p />
* <p>
* Using this annotation on any other class than a {@link ConfigurationSerializable} will
* have no effect.
* @see ConfigurationSerialization#registerClass(Class, String)
@@ -22,7 +22,7 @@ import java.lang.annotation.Target;
public @interface SerializableAs {
/**
* This is the name your class will be stored and retrieved as.
* <p />
* <p>
* This name MUST be unique. We recommend using names such as "MyPluginThing" instead of
* "Thing".
*