Merge pull request #1252 from octo-byte/octobyte/ocd

Fixes JavaDoc issues in #1000; removes implements DataSerializable from ItemStack

src/main/java/org/spongepowered/api/command/args/GenericArguments.java

@@ -250,7 +250,7 @@ public static CommandFlags.Builder flags() {
     }
 
     /**
-     * Consumes a series of arguments. Usage is the elements concated
+     * Consumes a series of arguments. Usage is the elements concatenated
      *
      * @param elements The series of arguments to expect
      * @return the element to match the input
@@ -1238,7 +1238,7 @@ private double parseRelativeDouble(CommandArgs args, String arg, @Nullable Doubl
             boolean relative = arg.startsWith("~");
             if (relative) {
                 if (relativeTo == null) {
-                    throw args.createError(t("Relative position specified but source does not have a postion"));
+                    throw args.createError(t("Relative position specified but source does not have a position"));
                 }
                 arg = arg.substring(1);
                 if (arg.isEmpty()) {

src/main/java/org/spongepowered/api/command/spec/CommandSpec.java

@@ -314,7 +314,7 @@ public CommandExecutor getExecutor() {
     }
 
     /**
-     * Gets the active input tokenizer used for this commmand.
+     * Gets the active input tokenizer used for this command.
      *
      * @return This command's input tokenizer
      */

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

@@ -29,7 +29,7 @@
 /**
  * Represents an object that can be represented by a {@link DataContainer}.
  * <p>DataContainers received from {@link DataSerializable#toContainer()}
- * should be considered to be copies of the original data, and therefor,
+ * should be considered to be copies of the original data, and therefore,
  * thread safe.</p>
  */
 public interface DataSerializable {
@@ -38,7 +38,7 @@ public interface DataSerializable {
      * Gets the content version of this {@link DataSerializable}. The version
      * may differ between instances of plugins and implementations such that
      * the {@link DataView} from {@link #toContainer()} may include different
-     * information, or remove other information as they are no longer deemend
+     * information, or remove other information as they are no longer deemed
      * necessary. The version goes hand in hand with {@link DataContentUpdater}
      * as it is required when there exists any {@link DataView} of this
      * {@link DataSerializable} with an "older" version.

src/main/java/org/spongepowered/api/data/key/Keys.java

@@ -364,7 +364,6 @@ public final class Keys {
 
     public static final Key<Value<Fish>> FISH_TYPE = KeyFactory.fake("FISH_TYPE");
 
-    /**
     /**
      * Represents the {@link Key} for representing the
      * {@link FluidStackSnapshot} contained within an item container. Item

src/main/java/org/spongepowered/api/effect/potion/PotionEffectTypes.java

@@ -27,7 +27,7 @@
 import org.spongepowered.api.util.generator.dummy.DummyObjectProvider;
 
 /**
- * An enumaration of all possible {@link PotionEffectType}s in vanilla minecraft.
+ * An enumeration of all possible {@link PotionEffectType}s in vanilla Minecraft.
  */
 public final class PotionEffectTypes {
 

src/main/java/org/spongepowered/api/event/server/query/QueryServerEvent.java

@@ -229,7 +229,7 @@ interface Full extends Basic {
          * Gets the map of custom keys and values to respond with.
          *
          * <p>If settings any of the keys or values causes the message
-         * to go oer the maximum size, the message will be automatically
+         * to go over the maximum size, the message will be automatically
          * truncated.</p>
          *
          * @return The map of custom keys and values to respond with

src/main/java/org/spongepowered/api/item/inventory/ItemStack.java

@@ -33,7 +33,6 @@
 import org.spongepowered.api.block.BlockType;
 import org.spongepowered.api.block.tileentity.TileEntity;
 import org.spongepowered.api.data.DataHolder;
-import org.spongepowered.api.data.DataSerializable;
 import org.spongepowered.api.data.DataView;
 import org.spongepowered.api.data.key.Key;
 import org.spongepowered.api.data.manipulator.DataManipulator;
@@ -50,11 +49,11 @@
  * Represents a stack of a specific {@link ItemType}. Supports serialization and
  * can be compared using the comparators listed in {@link ItemStackComparators}.
  *
- * <p>{@link ItemStack}s have varying properties and data, it is adviseable to
- * use {@link DataHolder#get(Class)} to retrieve different information
- * regarding this item stack.</p>
+ * <p>{@link ItemStack}s have a variety of properties and data. It is advised to
+ * use {@link DataHolder#get(Class)} in order to retrieve information regarding
+ * this item stack.</p>
  */
-public interface ItemStack extends DataHolder, DataSerializable, Translatable {
+public interface ItemStack extends DataHolder, Translatable {
 
     /**
      * Creates a new {@link Builder} to build an {@link ItemStack}.

src/main/java/org/spongepowered/api/item/inventory/equipment/EquipmentTypes.java

@@ -34,7 +34,7 @@ public final class EquipmentTypes {
     // SORTFIELDS:ON
 
     /**
-     * Any type, all other types should sublass this to allow instanceof checks
+     * Any type, all other types should subclass this to allow instanceof checks
      * to succeed.
      */
     public static final EquipmentType ANY = DummyObjectProvider.createFor(EquipmentType.class, "ANY");

src/main/java/org/spongepowered/api/item/inventory/property/AcceptsItems.java

@@ -87,7 +87,7 @@ public int compareTo(Property<?, ?> other) {
 
     /**
      * Returns true if <em>other</em> is also an {@link AcceptsItems} property
-     * and <b>any</b> item appearing in the other property's collecion appears
+     * and <b>any</b> item appearing in the other property's collection appears
      * in this property's collection. In formal terms, the method returns true
      * if the size of the intersection between the two item type collections is
      * greater than zero.

src/main/java/org/spongepowered/api/item/inventory/type/TileEntityInventory.java

@@ -38,7 +38,7 @@
  * at liberty to return the TE object directly but as far as consumers are
  * concerned the TE instance and the inventory are separate things.
  *
- * <p>This is intented to provide a consistent way of dealing with inventories
+ * <p>This is intended to provide a consistent way of dealing with inventories
  * regardless of the "owner" of the inventory. Thus, any code capable of dealing
  * with a {@link Carrier} is intrinsically able to deal with a TE inventory just
  * as they would with any Entity inventory or any other type of Carrier for that

src/main/java/org/spongepowered/api/network/ChannelBuf.java

@@ -798,7 +798,7 @@ public interface ChannelBuf {
 
     /**
      * Sets the specified {@link DataView} at the current writerIndex and
-     * increases the writerIndex according to the lenght of the data view
+     * increases the writerIndex according to the length of the data view
      * in this buffer.
      *
      * @param data The data view data

src/main/java/org/spongepowered/api/service/permission/option/OptionSubjectData.java

@@ -61,7 +61,7 @@ public interface OptionSubjectData extends SubjectData {
      * Clear all options in the given context combination.
      *
      * @param contexts The context combination
-     * @return Whether the operation was successful (any options were remowed)
+     * @return Whether the operation was successful (any options were removed)
      */
     boolean clearOptions(Set<Context> contexts);
 

src/main/java/org/spongepowered/api/statistic/StatisticFormat.java

@@ -37,7 +37,7 @@ public interface StatisticFormat extends CatalogType {
      * Formats the given value from the statistic to a human readable form.
      *
      * @param value The value to format
-     * @return The formated value
+     * @return The formatted value
      */
     String format(long value);
 

src/main/java/org/spongepowered/api/util/Direction.java

@@ -286,7 +286,7 @@ public boolean isCardinal() {
 
     /**
      * Return true if the direction is of an ordinal direction (northwest,
-     * southwest, southeast, northeaast).
+     * southwest, southeast, northeast).
      *
      * @return True if ordinal
      */

src/main/java/org/spongepowered/api/world/ChunkTicketManager.java

@@ -168,7 +168,7 @@ interface LoadingTicket {
          * Sets the number of chunks this ticket will load at once.
          *
          * @param numChunks The number of chunks this ticket can load at once
-         * @return True if sucessful, false if the number of chunks is above the
+         * @return True if successful, false if the number of chunks is above the
          *         maximum allowed for this ticket
          */
         boolean setNumChunks(int numChunks);

src/main/java/org/spongepowered/api/world/World.java

@@ -176,7 +176,7 @@ default Optional<Chunk> loadChunk(Vector3i chunkPosition, boolean shouldGenerate
 
     /**
      * Gets the entity whose {@link UUID} matches the provided id, possibly
-     * returning no entity if the entity is not loaded or non-existant.
+     * returning no entity if the entity is not loaded or non-existent.
      *
      * <p>For world implementations, only some parts of the world is usually
      * loaded, so this method may return no entity if the entity is not

src/main/java/org/spongepowered/api/world/gen/populator/Lake.java

@@ -32,7 +32,7 @@
 
 /**
  * Represents a populator which will attempt to spawn lakes within the chunk
- * dependending on a random chance.
+ * depending on a random chance.
  */
 public interface Lake extends Populator {
 

src/main/java/org/spongepowered/api/world/storage/WorldStorage.java

@@ -56,7 +56,7 @@ public interface WorldStorage {
      * exist in the world.
      *
      * <p>Note that this is an asynchronous check as the storage of chunks can
-     * not be guaranteed to remain in synch with the server, let alone on the
+     * not be guaranteed to remain in sync with the server, let alone on the
      * server thread.</p>
      *
      * <p>It is imperative to understand that the {@link CompletableFuture} task
@@ -74,7 +74,7 @@ public interface WorldStorage {
      *
      * <p>The container is a read only instance of the data, and therefor should
      * not be considered as mutable data. Changes are NOT saved, and the data
-     * may not be in synch with the server if the chunk is currently loaded.</p>
+     * may not be in sync with the server if the chunk is currently loaded.</p>
      *
      * <p>This may not return a {@link DataContainer} in the event there is no
      * chunk data generated at the desired coordinates.</p>