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>

paper-api/src/main/java/org/bukkit/configuration/serialization/ConfigurationSerializable.java

@@ -5,17 +5,18 @@ import java.util.Map;
 /**
  * Represents an object that may be serialized.
  * <p>
- * These objects MUST implement one of the following, in addition to the methods
- * as defined by this interface:
+ * These objects MUST implement one of the following, in addition to the
+ * methods as defined by this interface:
  * <ul>
- * <li>A static method "deserialize" that accepts a single {@link Map}&lt;{@link String}, {@link Object}>
- * and returns the class.</li>
- * <li>A static method "valueOf" that accepts a single {@link Map}&lt;{@link String}, {@link Object}>
- * and returns the class.</li>
- * <li>A constructor that accepts a single {@link Map}&lt;{@link String}, {@link Object}>.</li>
+ * <li>A static method "deserialize" that accepts a single {@link Map}&lt;
+ * {@link String}, {@link Object}> and returns the class.</li>
+ * <li>A static method "valueOf" that accepts a single {@link Map}&lt;{@link
+ * String}, {@link Object}> and returns the class.</li>
+ * <li>A constructor that accepts a single {@link Map}&lt;{@link String},
+ * {@link Object}>.</li>
  * </ul>
- * In addition to implementing this interface, you must register the class with
- * {@link ConfigurationSerialization#registerClass(Class)}.
+ * In addition to implementing this interface, you must register the class
+ * with {@link ConfigurationSerialization#registerClass(Class)}.
  *
  * @see DelegateDeserialization
  * @see SerializableAs
@@ -25,8 +26,8 @@ public interface ConfigurationSerializable {
     /**
      * Creates a Map representation of this class.
      * <p>
-     * This class must provide a method to restore this class, as defined in the
-     * {@link ConfigurationSerializable} interface javadocs.
+     * This class must provide a method to restore this class, as defined in
+     * the {@link ConfigurationSerializable} interface javadocs.
      *
      * @return Map containing the current state of this class
      */

paper-api/src/main/java/org/bukkit/configuration/serialization/ConfigurationSerialization.java

@@ -134,13 +134,15 @@ public class ConfigurationSerialization {
     }
 
     /**
-     * Attempts to deserialize the given arguments into a new instance of the given class.
+     * Attempts to deserialize the given arguments into a new instance of the
+     * given class.
      * <p>
-     * The class must implement {@link ConfigurationSerializable}, including the extra methods
-     * as specified in the javadoc of ConfigurationSerializable.
+     * The class must implement {@link ConfigurationSerializable}, including
+     * the extra methods as specified in the javadoc of
+     * ConfigurationSerializable.
      * <p>
-     * If a new instance could not be made, an example being the class not fully implementing
-     * the interface, null will be returned.
+     * If a new instance could not be made, an example being the class not
+     * fully implementing the interface, null will be returned.
      *
      * @param args Arguments for deserialization
      * @param clazz Class to deserialize into
@@ -151,13 +153,15 @@ public class ConfigurationSerialization {
     }
 
     /**
-     * Attempts to deserialize the given arguments into a new instance of the given class.
+     * Attempts to deserialize the given arguments into a new instance of the
+     * given class.
      * <p>
-     * The class must implement {@link ConfigurationSerializable}, including the extra methods
-     * as specified in the javadoc of ConfigurationSerializable.
+     * The class must implement {@link ConfigurationSerializable}, including
+     * the extra methods as specified in the javadoc of
+     * ConfigurationSerializable.
      * <p>
-     * If a new instance could not be made, an example being the class not fully implementing
-     * the interface, null will be returned.
+     * If a new instance could not be made, an example being the class not
+     * fully implementing the interface, null will be returned.
      *
      * @param args Arguments for deserialization
      * @return New instance of the specified class
@@ -188,7 +192,8 @@ public class ConfigurationSerialization {
     }
 
     /**
-     * Registers the given {@link ConfigurationSerializable} class by its alias
+     * Registers the given {@link ConfigurationSerializable} class by its
+     * alias
      *
      * @param clazz Class to register
      */
@@ -202,7 +207,8 @@ public class ConfigurationSerialization {
     }
 
     /**
-     * Registers the given alias to the specified {@link ConfigurationSerializable} class
+     * Registers the given alias to the specified {@link
+     * ConfigurationSerializable} class
      *
      * @param clazz Class to register
      * @param alias Alias to register as
@@ -222,7 +228,8 @@ public class ConfigurationSerialization {
     }
 
     /**
-     * Unregisters any aliases for the specified {@link ConfigurationSerializable} class
+     * Unregisters any aliases for the specified {@link
+     * ConfigurationSerializable} class
      *
      * @param clazz Class to unregister
      */
@@ -233,7 +240,8 @@ public class ConfigurationSerialization {
     }
 
     /**
-     * Attempts to get a registered {@link ConfigurationSerializable} class by its alias
+     * Attempts to get a registered {@link ConfigurationSerializable} class by
+     * its alias
      *
      * @param alias Alias of the serializable
      * @return Registered class, or null if not found
@@ -243,7 +251,8 @@ public class ConfigurationSerialization {
     }
 
     /**
-     * Gets the correct alias for the given {@link ConfigurationSerializable} class
+     * Gets the correct alias for the given {@link ConfigurationSerializable}
+     * class
      *
      * @param clazz Class to get alias for
      * @return Alias to use for the class

paper-api/src/main/java/org/bukkit/configuration/serialization/DelegateDeserialization.java

@@ -6,14 +6,15 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
- * Applies to a {@link ConfigurationSerializable} that will delegate all deserialization to another
- * {@link ConfigurationSerializable}.
+ * Applies to a {@link ConfigurationSerializable} that will delegate all
+ * deserialization to another {@link ConfigurationSerializable}.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface DelegateDeserialization {
     /**
-     * Which class should be used as a delegate for this classes deserialization
+     * Which class should be used as a delegate for this classes
+     * deserialization
      *
      * @return Delegate class
      */

paper-api/src/main/java/org/bukkit/configuration/serialization/SerializableAs.java

@@ -6,15 +6,16 @@ import java.lang.annotation.RetentionPolicy;
 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.
+ * 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>
- * This value will be stored in the configuration so that the configuration deserialization
- * can determine what type it is.
+ * This value will be stored in the configuration so that the configuration
+ * deserialization can determine what type it is.
  * <p>
- * Using this annotation on any other class than a {@link ConfigurationSerializable} will
- * have no effect.
+ * Using this annotation on any other class than a {@link
+ * ConfigurationSerializable} will have no effect.
  *
  * @see ConfigurationSerialization#registerClass(Class, String)
  */
@@ -24,8 +25,8 @@ public @interface SerializableAs {
     /**
      * This is the name your class will be stored and retrieved as.
      * <p>
-     * This name MUST be unique. We recommend using names such as "MyPluginThing" instead of
-     * "Thing".
+     * This name MUST be unique. We recommend using names such as
+     * "MyPluginThing" instead of "Thing".
      *
      * @return Name to serialize the class as.
      */