Fix javadoc issues with link references. Fix many other issues from #221.

Signed-off-by: Gabriel Harris-Rouquette <[email protected]>

Author: gabizou

src/main/java/org/spongepowered/api/CatalogType.java

@@ -39,8 +39,8 @@ public interface CatalogType {
     String getId();
 
     /**
-     * Gets the unique human-readable name of this individual {@link
-     * CatalogType}.
+     * Gets the unique human-readable name of this individual
+     * {@link CatalogType}.
      *
      * @return The uniquely identifiable name of this catalog type
      */

src/main/java/org/spongepowered/api/CatalogTypes.java

@@ -98,8 +98,8 @@
 
 /**
  * Enumeration of all known {@link CatalogType}s for autocompletion when using the
- * {@link GameRegistry#getType(Class, String)} and {@link
- * GameRegistry#getAllOf(Class)}.
+ * {@link GameRegistry#getType(Class, String)} and
+ * {@link GameRegistry#getAllOf(Class)}.
  */
 public final class CatalogTypes {
 

src/main/java/org/spongepowered/api/GameRegistry.java

@@ -106,8 +106,8 @@ public interface GameRegistry {
     <T extends CatalogType> Optional<T> getType(Class<T> typeClass, String id);
 
     /**
-     * Gets a collection of all available found specific types of {@link
-     * CatalogType} requested.
+     * Gets a collection of all available found specific types of
+     * {@link CatalogType} requested.
      *
      * <p>The presented {@link CatalogType}s may not exist in default catalogs
      * due to various reasons including but not restricted to: mods, plugins,

src/main/java/org/spongepowered/api/block/BlockType.java

@@ -50,6 +50,7 @@ public interface BlockType extends CatalogType, Translatable {
      *
      * @return The id
      */
+    @Override
     String getName();
 
     /**

src/main/java/org/spongepowered/api/data/DataHolder.java

@@ -56,8 +56,8 @@ public interface DataHolder extends DataSerializable {
     /**
      * Gets or creates a new {@link DataManipulator} that can be accepted by
      * this {@link DataHolder}. In the event that there is no data that can
-     * be represented by the given {@link DataManipulator}, a new {@link
-     * DataManipulator} object is created with default values.
+     * be represented by the given {@link DataManipulator}, a new
+     * {@link DataManipulator} object is created with default values.
      *
      * <p>In the event the {@link DataManipulator} can not represent any data
      * pertaining to this {@link DataHolder}, {@link Optional#absent()} is
@@ -88,8 +88,8 @@ public interface DataHolder extends DataSerializable {
      *
      * @param manipulatorClass The data class
      * @param <T> The type of data
-     * @return True if this {@link DataHolder} can accept the {@link
-     *    DataManipulator} object
+     * @return True if this {@link DataHolder} can accept the
+     *     {@link DataManipulator} object
      */
     <T extends DataManipulator<T>> boolean isCompatible(Class<T> manipulatorClass);
 
@@ -100,8 +100,9 @@ public interface DataHolder extends DataSerializable {
      * would otherwise overlap existing data on this {@link DataHolder}, a
      * default {@link DataPriority#DATA_MANIPULATOR} is used.</p>
      *
-     * <p>If any data is rejected or existing data is replaced, the {@link
-     * DataTransactionResult} will retain the rejected and replaced data.</p>
+     * <p>If any data is rejected or existing data is replaced, the
+     * {@link DataTransactionResult} will retain the rejected and replaced
+     * data.</p>
      *
      * @param manipulatorData The manipulator data to offer
      * @param <T> The type of manipulator data
@@ -112,8 +113,9 @@ public interface DataHolder extends DataSerializable {
     /**
      * Offers the given {@link DataManipulator} to this {@link DataHolder}.
      *
-     * <p>If any data is rejected or existing data is replaced, the {@link
-     * DataTransactionResult} will retain the rejected and replaced data.</p>
+     * <p>If any data is rejected or existing data is replaced, the
+     * {@link DataTransactionResult} will retain the rejected and replaced
+     * data.</p>
      *
      * @param manipulatorData The manipulator data to offer
      * @param <T> The type of manipulator data
@@ -124,19 +126,19 @@ public interface DataHolder extends DataSerializable {
 
     /**
      * Gets an copied collection of all known {@link DataManipulator}s
-     * belonging to this {@link DataHolder}. An individual {@link
-     * DataManipulator} can be used for creating new data to replace on this
-     * {@link DataHolder}.
+     * belonging to this {@link DataHolder}. An individual
+     * {@link DataManipulator} can be used for creating new data to replace on
+     * this {@link DataHolder}.
      *
      * @return A collection of copied data manipulators belonging to this
      *     data holder
      */
     Collection<? extends DataManipulator<?>> getManipulators();
 
     /**
-     * Attempts to retrieve a specific {@link Property} type of this {@link
-     * DataHolder}. If the property is not applicable, {@link Optional#absent()}
-     * is returned.
+     * Attempts to retrieve a specific {@link Property} type of this
+     * {@link DataHolder}. If the property is not applicable,
+     * {@link Optional#absent()} is returned.
      *
      * <p>{@link Property}s can define various immutable information about a
      * {@link DataHolder} that is dependent on the instance of the holder.

src/main/java/org/spongepowered/api/data/DataManipulator.java

@@ -42,40 +42,41 @@ public interface DataManipulator<T extends DataManipulator<T>> extends Comparabl
     /**
      * Attempts to read data from the given {@link DataHolder} and constructs
      * a new copy of this {@link DataManipulator} as an instance of
-     * <code>T</code>. Any data that overlaps between this and the given {@link
-     * DataHolder} will be resolved by a default {@link DataPriority#PRE_MERGE}
-     * such that the current data from this {@link DataManipulator} will be
-     * applied before the existing data from the {@link DataHolder}.
+     * <code>T</code>. Any data that overlaps between this and the given
+     * {@link DataHolder} will be resolved by a default
+     * {@link DataPriority#PRE_MERGE} such that the current data from this
+     * {@link DataManipulator} will be applied before the existing data from
+     * the {@link DataHolder}.
      *
      * <p>Any data that overlaps existing data from the {@link DataHolder} will
      * take priority and be overwriten from the pre-existing data from the
-     * {@link DataHolder}. It is recommended that a call from {@link
-     * DataHolder#isCompatible(Class)} is checked prior to using this method on
-     * any {@link DataHolder}.</p>
+     * {@link DataHolder}. It is recommended that a call from
+     * {@link DataHolder#isCompatible(Class)} is checked prior to using this
+     * method on any {@link DataHolder}.</p>
      *
      * @param dataHolder The {@link DataHolder} to extract data
-     * @return A new instance of this {@link DataManipulator} with relevant data
-     *     filled from the given {@link DataHolder}
+     * @return A new instance of this {@link DataManipulator} with relevant
+     *     data filled from the given {@link DataHolder}
      */
     Optional<T> fill(DataHolder dataHolder);
 
     /**
      * Attempts to read data from the given {@link DataHolder} and constructs
      * a new copy of this {@link DataManipulator} as an instance of
-     * <code>T</code>. Any data overlap that exists in both the {@link
-     * DataHolder} and this {@link DataManipulator} will be resolved using the
-     * given {@link DataPriority}.
+     * <code>T</code>. Any data that overlaps between this and the given
+     * {@link DataHolder} will be resolved using the given
+     * {@link DataPriority}.
      *
      * <p>Any data that overlaps existing data from the {@link DataHolder} will
      * take priority and be overwriten from the pre-existing data from the
-     * {@link DataHolder}. It is recommended that a call from {@link
-     * DataHolder#isCompatible(Class)} is checked prior to using this method on
-     * any {@link DataHolder}.</p>
+     * {@link DataHolder}. It is recommended that a call from
+     * {@link DataHolder#isCompatible(Class)} is checked prior to using this
+     * method on any {@link DataHolder}.</p>
      *
      * @param dataHolder The {@link DataHolder} to extract data
      * @param overlap The overlap resolver to decide which data to retain
-     * @return A new instance of this {@link DataManipulator} with relevant data
-     *     filled from the given {@link DataHolder}
+     * @return A new instance of this {@link DataManipulator} with relevant
+     *     data filled from the given {@link DataHolder}
      */
     Optional<T> fill(DataHolder dataHolder, DataPriority overlap);
 

src/main/java/org/spongepowered/api/data/DataPriority.java

@@ -25,15 +25,15 @@
 package org.spongepowered.api.data;
 
 /**
- * A data priority enum. When merging existing data from a {@link
- * DataHolder} and a {@link DataManipulator}, the priority defines which
- * data to retain, and or, merge.
+ * A data priority enum. When merging existing data from a {@link DataHolder}
+ * and a {@link DataManipulator}, the priority defines which data to retain,
+ * and or, merge.
  */
 public enum DataPriority {
     /**
      * The data residing in the {@link DataHolder} should be retained,
-     * ignoring all overlapping data from thie owning {@link
-     * DataManipulator}.
+     * ignoring all overlapping data from the owning
+     * {@link DataManipulator}.
      */
     DATA_HOLDER,
     /**
@@ -43,16 +43,16 @@ public enum DataPriority {
     DATA_MANIPULATOR,
     /**
      * All overlapping data from the {@link DataManipulator} will be
-     * added before the overlapping data existing from the {@link
-     * DataHolder}. Examples may include prefixing display names,
+     * added before the overlapping data existing from the
+     * {@link DataHolder}. Examples may include prefixing display names,
      * adding enchantments at the beginning of an enchantment list, etc.
      */
     PRE_MERGE,
     /**
      * All overlapping data from the {@link DataManipulator} will be
-     * added after the overlapping data existing from the {@link
-     * DataHolder}. Examples may include suffixing display names,
-     * adding enchantments at the end of an enchantment list, etc.
+     * added after the overlapping data existing from the {@link DataHolder}.
+     * Examples may include suffixing display names, adding enchantments at
+     * the end of an enchantment list, etc.
      */
     POST_MERGE,
     ;

src/main/java/org/spongepowered/api/data/DataTransactionResult.java

@@ -62,15 +62,15 @@ enum Type {
 
         /**
          * The {@link DataManipulator} operation failed because an
-         * <em>unexpected</em> condition occurred. The state of the {@link
-         * DataManipulator} is undefined.
+         * <em>unexpected</em> condition occurred. The state of the
+         * {@link DataManipulator} is undefined.
          */
         ERROR,
 
         /**
-         * An operation was cancelled by a third party (eååg. an {@link
-         * DataManipulator} event was cancelled). The condition of the {@link
-         * DataManipulator} is unchanged.
+         * An operation was cancelled by a third party (eg. a
+         * {@link DataManipulator} event was cancelled). The condition of the
+         * {@link DataManipulator} is unchanged.
          */
         CANCELLED,
         ;

src/main/java/org/spongepowered/api/data/manipulators/SingleValueData.java

@@ -28,8 +28,8 @@
 
 /**
  * Represents a {@link DataManipulator} that handles a single value with
- * default provided methods to {@link #getValue()} and {@link
- * #setValue(Object)}.
+ * default provided methods to {@link #getValue()} and
+ * {@link #setValue(Object)}.
  *
  * @param <V> The value of the data
  * @param <T> The implementing manipulator for comparison

src/main/java/org/spongepowered/api/entity/Entity.java

@@ -33,6 +33,7 @@
 import org.spongepowered.api.world.Location;
 import org.spongepowered.api.world.TeleportHelper;
 import org.spongepowered.api.world.World;
+import org.spongepowered.api.world.storage.WorldProperties;
 
 import java.util.EnumSet;
 import java.util.UUID;
@@ -149,8 +150,8 @@ public interface Entity extends Identifiable, DataHolder, DataSerializable {
      * @param location The location to set
      * @param rotation The rotation to set
      * @param relativePositions The coordinates to set relatively
-     * @return True if location was set successfully, false if location couldn't
-     *         be set as no safe location was found
+     * @return True if location was set successfully, false if location
+     *     couldn't be set as no safe location was found
      */
     boolean setLocationAndRotationSafely(Location location, Vector3d rotation, EnumSet<RelativePositions> relativePositions);
 
@@ -159,16 +160,14 @@ public interface Entity extends Identifiable, DataHolder, DataSerializable {
      * not have to be loaded (but must at least be enabled).
      *
      * <p>If the target world is loaded then this is equivalent to
-     * setting the location via {@link
-     * TargetedLocationData}.</p>
+     * setting the location via {@link TargetedLocationData}.</p>
      *
      * <p>If the target world is unloaded but is enabled according to its
-     * {@link org.spongepowered.api.world.storage.WorldProperties#isEnabled()}
-     * then this will first load the world before transferring the entity to
-     * that world.</p>
+     * {@link WorldProperties#isEnabled()} then this will first load the world
+     * before transferring the entity to that world.</p>
      *
-     * <p>If the target world is unloaded and not enabled then the transfer will
-     * fail.</p>
+     * <p>If the target world is unloaded and not enabled then the transfer
+     * will fail.</p>
      *
      * @param worldName The name of the world to transfer to
      * @param position The position in the target world
@@ -181,16 +180,14 @@ public interface Entity extends Identifiable, DataHolder, DataSerializable {
      * not have to be loaded (but must at least be enabled).
      *
      * <p>If the target world is loaded then this is equivalent to
-     * setting the location via {@link
-     * TargetedLocationData}.</p>
+     * setting the location via {@link TargetedLocationData}.</p>
      *
      * <p>If the target world is unloaded but is enabled according to its
-     * {@link org.spongepowered.api.world.storage.WorldProperties#isEnabled()}
-     * then this will first load the world before transferring the entity to
-     * that world.</p>
+     * {@link WorldProperties#isEnabled()} then this will first load the world
+     * before transferring the entity to that world.</p>
      *
-     * <p>If the target world is unloaded and not enabled then the transfer will
-     * fail.</p>
+     * <p>If the target world is unloaded and not enabled then the transfer
+     * will fail.</p>
      *
      * @param uuid The UUID of the target world to transfer to
      * @param position The position in the target world