[#1000]: Fix minor issues

dualspiral · dualspiral · commit b70499c9396a · 2020-03-14T13:12:39.000Z
diff --git a/src/main/java/org/spongepowered/api/GameRegistry.java b/src/main/java/org/spongepowered/api/GameRegistry.java
@@ -418,7 +418,7 @@ <T extends CatalogType> GameRegistry registerModule(Class<T> catalogClass, Catal
     /**
      * Gets a locale for the specified locale code, e.g. {@code en_US}.
      *
-     * @param locale The locale to lookup (e.g. {@code en_US}.
+     * @param locale The locale to lookup (e.g. {@code en_US}).
      * @return The locale
      */
     Locale getLocale(String locale);
diff --git a/src/main/java/org/spongepowered/api/Server.java b/src/main/java/org/spongepowered/api/Server.java
@@ -273,7 +273,7 @@ public interface Server {
      * Gets the 'server' scoreboard. In Vanilla, this is the scoreboard of
      * dimension 0 (the overworld).
      *
-     * <p>The sever scoreboard is used with the Vanilla /scoreboard command,
+     * <p>The server scoreboard is used with the Vanilla /scoreboard command,
      * automatic score updating through criteria, and other things.</p>
      *
      * <p>The server scoreboard may not be available if dimension 0
@@ -356,8 +356,8 @@ public interface Server {
     Text getMotd();
 
     /**
-     * Shuts down the server, and kicks all players with the default kic
-     * k message.
+     * Shuts down the server, and kicks all players with the default kick
+     * message.
      *
      * <p>For the Sponge implementation on the client, this will trigger the
      * Integrated Server to shutdown a tick later.</p>
diff --git a/src/main/java/org/spongepowered/api/data/DataTransactionResult.java b/src/main/java/org/spongepowered/api/data/DataTransactionResult.java
@@ -497,7 +497,7 @@ public Builder reject(final Iterable<ImmutableValue<?>> values) {
 
         /**
          * Adds the provided {@link ImmutableValue} to the {@link List} of
-         * "successful" {@link ImmutableValue}s. The rejected values are always
+         * "successful" {@link ImmutableValue}s. The successful values are always
          * copied for every {@link DataTransactionResult} for referencing. It is
          * also possible to retrieve these successful {@link ImmutableValue}s to
          * {@link DataHolder#undo(DataTransactionResult)} at a later point in
diff --git a/src/main/java/org/spongepowered/api/data/key/Keys.java b/src/main/java/org/spongepowered/api/data/key/Keys.java
@@ -2239,7 +2239,7 @@ public final class Keys {
      * entities or collide with other entities.</p>
      *
      * <p>Vanishing an {@link Entity} ridden by other entities (see
-     * {@link #PASSENGERS} will cause problems.</p>
+     * {@link #PASSENGERS}) will cause problems.</p>
      *
      * @see Keys#VANISH
      */
diff --git a/src/main/java/org/spongepowered/api/data/manipulator/mutable/block/PortionData.java b/src/main/java/org/spongepowered/api/data/manipulator/mutable/block/PortionData.java
@@ -33,7 +33,7 @@
 /**
  * An {@link VariantData} for the {@link PortionType}. This has some mechanics
  * with the partial bounding boxes for the actual blocks. Usually applicable
- * to {@link BlockTypes#DOUBLE_PLANT}, {@link BlockTypes#STONE_SLAB}
+ * to {@link BlockTypes#DOUBLE_PLANT}, {@link BlockTypes#STONE_SLAB},
  * {@link BlockTypes#WOODEN_DOOR}s, etc.
  *
  * @see Keys#PORTION_TYPE
diff --git a/src/main/java/org/spongepowered/api/data/property/LocationBasePropertyHolder.java b/src/main/java/org/spongepowered/api/data/property/LocationBasePropertyHolder.java
@@ -38,10 +38,11 @@ public interface LocationBasePropertyHolder {
      * specific location. If the property is not applicable,
      * {@link Optional#empty()} is returned.
      *
-     * <p>{@link Property}s can define various immutable information about a
-     * {@link PropertyHolder} that is dependent on the instance of the holder.
-     * As {@link Property}s cannot be changed, the {@link PropertyHolder} can
-     * not change the information about it's own properties either.</p>
+     * <p>{@link Property properties} can define various immutable information
+     * about a {@link PropertyHolder} that is dependent on the instance of the
+     * holder. As {@link Property properties} cannot be changed, the
+     * {@link PropertyHolder} can not change the information about its own
+     * properties either.</p>
      *
      * @param coords The coordinates
      * @param propertyClass The property class
@@ -57,10 +58,11 @@ public interface LocationBasePropertyHolder {
      * {@link PropertyHolder}. If the property is not applicable,
      * {@link Optional#empty()} is returned.
      *
-     * <p>{@link Property}s can define various immutable information about a
-     * {@link PropertyHolder} that is dependent on the instance of the holder.
-     * As {@link Property}s cannot be changed, the {@link PropertyHolder} can
-     * not change the information about it's own properties either.</p>
+     * <p>{@link Property properties} can define various immutable information
+     * about a {@link PropertyHolder} that is dependent on the instance of the
+     * holder. As {@link Property properties} cannot be changed, the
+     * {@link PropertyHolder} can not change the information about it's own
+     * properties either.</p>
      *
      * @param x The x coordinate
      * @param y The y coordinate
@@ -76,10 +78,11 @@ public interface LocationBasePropertyHolder {
      * specific location on the given block face. If the property is not
      * applicable, {@link Optional#empty()} is returned.
      *
-     * <p>{@link Property}s can define various immutable information about a
-     * {@link PropertyHolder} that is dependent on the instance of the holder.
-     * As {@link Property}s cannot be changed, the {@link PropertyHolder} can
-     * not change the information about it's own properties either.</p>
+     * <p>{@link Property properties} can define various immutable information
+     * about a {@link PropertyHolder} that is dependent on the instance of the
+     * holder. As {@link Property properties} cannot be changed, the
+     * {@link PropertyHolder} can not change the information about it's own
+     * properties either.</p>
      *
      * @param coords The coordinates
      * @param direction The face of the block
@@ -96,10 +99,11 @@ public interface LocationBasePropertyHolder {
      * specific location on the given block face. If the property is not
      * applicable, {@link Optional#empty()} is returned.
      *
-     * <p>{@link Property}s can define various immutable information about a
-     * {@link PropertyHolder} that is dependent on the instance of the holder.
-     * As {@link Property}s cannot be changed, the {@link PropertyHolder} can
-     * not change the information about it's own properties either.</p>
+     * <p>{@link Property properties} can define various immutable information
+     * about a {@link PropertyHolder} that is dependent on the instance of the
+     * holder. As {@link Property properties} cannot be changed, the
+     * {@link PropertyHolder} can not change the information about it's own
+     * properties either.</p>
      *
      * @param x The x coordinate
      * @param y The y coordinate
@@ -115,11 +119,11 @@ public interface LocationBasePropertyHolder {
      * Gets an immutable collection of all known {@link Property}s pertaining to
      * this {@link PropertyHolder}.
      *
-     * <p>{@link Property}s can not be changed such that the property is
-     * attached to the instance of the residing {@link PropertyHolder}.</p>
+     * <p>{@link Property properties} can not be changed such that the property
+     * is attached to the instance of the residing {@link PropertyHolder}.</p>
      *
      * @param coords The coordinates
-     * @return An immutable collection of all known {@link Property}s
+     * @return An immutable collection of all known {@link Property properties}
      */
     default Collection<Property<?, ?>> getProperties(Vector3i coords) {
         return getProperties(coords.getX(), coords.getY(), coords.getZ());
@@ -129,8 +133,8 @@ public interface LocationBasePropertyHolder {
      * Gets an immutable collection of all known {@link Property}s pertaining to
      * this {@link PropertyHolder}.
      *
-     * <p>{@link Property}s can not be changed such that the property is
-     * attached to the instance of the residing {@link PropertyHolder}.</p>
+     * <p>{@link Property properties} can not be changed such that the property
+     * is attached to the instance of the residing {@link PropertyHolder}.</p>
      *
      * @param x The x coordinate
      * @param y The y coordinate
diff --git a/src/main/java/org/spongepowered/api/data/property/PropertyHolder.java b/src/main/java/org/spongepowered/api/data/property/PropertyHolder.java
@@ -36,10 +36,11 @@ public interface PropertyHolder {
      * {@link PropertyHolder}. If the property is not applicable,
      * {@link Optional#empty()} is returned.
      *
-     * <p>{@link Property}s can define various immutable information about a
-     * {@link PropertyHolder} that is dependent on the instance of the holder.
-     * As {@link Property}s cannot be changed, the {@link PropertyHolder} can
-     * not change the information about it's own properties either.</p>
+     * <p>{@link Property properties} can define various immutable information
+     * about a {@link PropertyHolder} that is dependent on the instance of the
+     * holder. As {@link Property properties} cannot be changed, the
+     * {@link PropertyHolder} can not change the information about its own
+     * properties either.</p>
      *
      * @param propertyClass The property class
      * @param <T> The type of property
@@ -51,10 +52,10 @@ public interface PropertyHolder {
      * Gets an immutable collection of all known {@link Property}s pertaining
      * to this {@link PropertyHolder}.
      *
-     * <p>{@link Property}s can not be changed such that the property is
-     * attached to the instance of the residing {@link PropertyHolder}.</p>
+     * <p>{@link Property properties} can not be changed such that the property
+     * is attached to the instance of the residing {@link PropertyHolder}.</p>
      *
-     * @return An immutable collection of all known {@link Property}s
+     * @return An immutable collection of all known {@link Property properties}
      */
     Collection<Property<?, ?>> getApplicableProperties();
 
diff --git a/src/main/java/org/spongepowered/api/data/property/block/ReplaceableProperty.java b/src/main/java/org/spongepowered/api/data/property/block/ReplaceableProperty.java
@@ -29,7 +29,7 @@
 /**
  * Gets if a block type can be replaced by other block types when other
  * blocks are being placed. In short, the case where the value is
- * <code>true</code>,
+ * <code>true</code>, it can be replaced.
  */
 public class ReplaceableProperty extends BooleanProperty {
 
@@ -46,8 +46,8 @@ public ReplaceableProperty(boolean value) {
     /**
      * Creates a new {@link ReplaceableProperty} with the provided
      * {@code value} and
-     * {@link org.spongepowered.api.data.Property.Operator operator} for
-     * comparisons.
+     * {@link org.spongepowered.api.data.Property.Operator operator}
+     * for comparisons.
      *
      * @param value The value
      * @param operator The operator
diff --git a/src/main/java/org/spongepowered/api/data/value/BoundedValue.java b/src/main/java/org/spongepowered/api/data/value/BoundedValue.java
@@ -44,7 +44,7 @@ public interface BoundedValue<E> extends BaseValue<E> {
     /**
      * Gets the required "minimum" value such that the value is only valid if
      * the following is true:
-     * <pre>{@code if (getComparator().compare(getValue(), getMinValue()) <= 0)
+     * <pre>{@code if (getComparator().compare(getValue(), getMinValue()) >= 0)
      * }</pre>.
      *
      * @return The supposed minimum value
@@ -54,7 +54,7 @@ public interface BoundedValue<E> extends BaseValue<E> {
     /**
      * Gets the required "maximum" value such that the value is only valid if
      * the following is true:
-     * <pre>{@code if (getComparator().compare(getValue(), getMaxValue()) >= 0)
+     * <pre>{@code if (getComparator().compare(getValue(), getMaxValue()) <= 0)
      * }</pre>.
      *
      * @return The supposed maximum value
diff --git a/src/main/java/org/spongepowered/api/entity/Entity.java b/src/main/java/org/spongepowered/api/entity/Entity.java
@@ -381,7 +381,7 @@ default boolean transferToWorld(UUID uuid, Vector3d position) {
     boolean hasPassenger(Entity entity);
 
     /**
-     * Sets the passenger entity(the entity that rides this one).
+     * Sets the passenger entity (the entity that rides this one).
      *
      * @param entity The entity passenger, or null to eject
      * @return If adding the passenger succeeded
@@ -408,7 +408,7 @@ default boolean transferToWorld(UUID uuid, Vector3d position) {
     Optional<Entity> getVehicle();
 
     /**
-     * Sets the vehicle entity(the entity that is ridden by this one).
+     * Sets the vehicle entity (the entity that is ridden by this one).
      *
      * @param entity The entity vehicle, or null to dismount
      * @return True if the set was successful
diff --git a/src/main/java/org/spongepowered/api/event/entity/living/humanoid/player/PlayerChangeClientSettingsEvent.java b/src/main/java/org/spongepowered/api/event/entity/living/humanoid/player/PlayerChangeClientSettingsEvent.java
@@ -32,7 +32,7 @@
 import java.util.Set;
 
 /**
- * Fired when A {@link Player} changes one or more of the following settings.
+ * Fired when a {@link Player} changes one or more of the following settings.
  *
  * <ul>
  *   <li>Locale</li>
diff --git a/src/main/java/org/spongepowered/api/event/item/inventory/UseItemStackEvent.java b/src/main/java/org/spongepowered/api/event/item/inventory/UseItemStackEvent.java
@@ -31,6 +31,9 @@
 import org.spongepowered.api.item.inventory.ItemStack;
 import org.spongepowered.api.item.inventory.ItemStackSnapshot;
 
+/**
+ * Fired when an {@link ItemStack} is used.
+ */
 public interface UseItemStackEvent extends Event {
 
     /**
@@ -126,9 +129,9 @@ interface Tick extends UseItemStackEvent, Cancellable {}
     interface Stop extends UseItemStackEvent, Cancellable {}
 
     /**
-     * Fired when an item uis finished 'normally', e.g. used for the
+     * Fired when an item is finished 'normally', e.g. used for the
      * entire maximum duration. In contrast to {@link Stop}, this
-     * even will not fire if the item use was interrupted in any way.
+     * event will not fire if the item use was interrupted in any way.
      *
      * <p>Examples:</p>
      *
diff --git a/src/main/java/org/spongepowered/api/event/message/MessageChannelEvent.java b/src/main/java/org/spongepowered/api/event/message/MessageChannelEvent.java
@@ -59,8 +59,8 @@ public interface MessageChannelEvent extends MessageEvent {
     /**
      * Sets the channel for this message to go to.
      *
-     * <p>Note that an {@link Optional#empty()} channel is different from a
-     * {@link MessageChannel#TO_NONE} channel.</p>
+     * <p>Note that setting this to {@code null}, or no channel, is different
+     * from a {@link MessageChannel#TO_NONE} channel.</p>
      *
      * @param channel The channel to set
      */
diff --git a/src/main/java/org/spongepowered/api/event/sound/PlaySoundEvent.java b/src/main/java/org/spongepowered/api/event/sound/PlaySoundEvent.java
@@ -54,26 +54,31 @@ public interface PlaySoundEvent extends Event, Cancellable {
     Location<World> getLocation();
 
     /**
-     * Gets the {@link SoundCategory} for the sound being played
-     * @return
+     * Gets the {@link SoundCategory} for the sound being played.
+     *
+     *  @return The {@link SoundCategory}
      */
     SoundCategory getSoundCategory();
 
     /**
-     * Gets the {@link SoundType} for the sound being played
-     * @return
+     * Gets the {@link SoundType} for the sound being played.
+     *
+     * @return {@link SoundType}
      */
     SoundType getSoundType();
 
     /**
-     * Gets the volume of the sound being played
-     * @return
+     * Gets the volume of the sound being played.
+     *
+     * @return A float that represents the relative volume. This value may be
+     *         positive value.
      */
     float getVolume();
 
     /**
      * Gets the pitch of the sound being played
-     * @return
+     *
+     * @return A float that represents the pitch.
      */
     float getPitch();
 
diff --git a/src/main/java/org/spongepowered/api/event/world/UnloadWorldEvent.java b/src/main/java/org/spongepowered/api/event/world/UnloadWorldEvent.java
@@ -25,9 +25,10 @@
 package org.spongepowered.api.event.world;
 
 import org.spongepowered.api.event.Cancellable;
+import org.spongepowered.api.world.World;
 
 /**
- * Base event for when a @link World} is unloaded.
+ * Base event for when a {@link World} is unloaded.
  */
 public interface UnloadWorldEvent extends TargetWorldEvent, Cancellable {
 
diff --git a/src/main/java/org/spongepowered/api/service/economy/EconomyService.java b/src/main/java/org/spongepowered/api/service/economy/EconomyService.java
@@ -96,7 +96,7 @@ public interface EconomyService extends ContextualService<Account> {
      * Gets the {@link UniqueAccount} for the user with the specified
      * {@link UUID}.
      *
-     * <p>If an account does not already exists with the specified {@link UUID},
+     * <p>If an account does not already exist with the specified {@link UUID},
      * it will be created.</p>
      *
      * <p>Creation might fail if the provided {@link UUID} does not correspond
@@ -113,7 +113,7 @@ public interface EconomyService extends ContextualService<Account> {
      * <p>Depending on the implementation, the {@link Account} may be a
      * {@link UniqueAccount} or a {@link VirtualAccount}.</p>
      *
-     * <p>If an account does not already exists with the specified identifier,
+     * <p>If an account does not already exist with the specified identifier,
      * it will be created.</p>
      *
      * <p>Creation may fail for an implementation-defined reason.</p>
diff --git a/src/main/java/org/spongepowered/api/service/economy/account/Account.java b/src/main/java/org/spongepowered/api/service/economy/account/Account.java
@@ -174,7 +174,7 @@ default BigDecimal getBalance(Currency currency) {
 
     /**
      * Returns a {@link Map} of all currently set balances the account holds
-     * within the current active {@link Context}s.2
+     * within the current active {@link Context}.
      *
      * <p>Amounts may differ depending on the {@link Context}s specified and
      * the implementation. The set of {@link Context}s may be empty.</p>
diff --git a/src/main/java/org/spongepowered/api/service/permission/Subject.java b/src/main/java/org/spongepowered/api/service/permission/Subject.java
@@ -61,7 +61,7 @@
  * of a {@link NodeTree} is recommended.</p>
  *
  * <p>Plugins may opt to implement "dynamic" permissions such as {@code
- * example.region.define.&lt;region&gt;} where {@code region} would depend on
+ * example.region.define.[region]} where {@code region} would depend on
  * the context of the check. Attention should be made towards the handling of
  * periods / full stops in such cases.</p>
  *
@@ -135,7 +135,7 @@ public interface Subject extends Contextual {
      * <p>For subjects which are not persisted, the same store will be returned
      * by {@link #getTransientSubjectData()}.</p>
      *
-     * @return The the primary data backing for this Subject
+     * @return The primary data backing for this Subject
      */
     SubjectData getSubjectData();
 
diff --git a/src/main/java/org/spongepowered/api/world/extent/BiomeVolume.java b/src/main/java/org/spongepowered/api/world/extent/BiomeVolume.java
@@ -134,7 +134,7 @@ default BiomeType getBiome(Vector3i position) {
 
     /**
      * Returns a new volume that is translated so that
-     * {@link BiomeVolume#getBiomeMin()} returns {@link Vector2i#ZERO}. This
+     * {@link BiomeVolume#getBiomeMin()} returns {@link Vector3i#ZERO}. This
      * does not copy the biomes, it only provides a new view of the storage.
      *
      * @return The new volume with its minimum at zero
diff --git a/src/main/java/org/spongepowered/api/world/extent/ImmutableBiomeVolume.java b/src/main/java/org/spongepowered/api/world/extent/ImmutableBiomeVolume.java
@@ -64,7 +64,7 @@ public interface ImmutableBiomeVolume extends UnmodifiableBiomeVolume {
 
     /**
      * Returns a new volume that is translated so that
-     * {@link BiomeVolume#getBiomeMin()} returns {@link Vector2i#ZERO}. This
+     * {@link BiomeVolume#getBiomeMin()} returns {@link Vector3i#ZERO}. This
      * does not copy the biomes, it only provides a new view of the storage.
      *
      * @return The new volume with its minimum at zero
diff --git a/src/main/java/org/spongepowered/api/world/extent/MutableBiomeVolume.java b/src/main/java/org/spongepowered/api/world/extent/MutableBiomeVolume.java
@@ -88,7 +88,7 @@ default void setBiome(Vector3i position, BiomeType biome) {
 
     /**
      * Returns a new volume that is translated so that
-     * {@link BiomeVolume#getBiomeMin()} returns {@link Vector2i#ZERO}. This does
+     * {@link BiomeVolume#getBiomeMin()} returns {@link Vector3i#ZERO}. This does
      * not copy the biomes, it only provides a new view of the storage.
      *
      * @return The new volume with its minimum at zero
diff --git a/src/main/java/org/spongepowered/api/world/extent/UnmodifiableBiomeVolume.java b/src/main/java/org/spongepowered/api/world/extent/UnmodifiableBiomeVolume.java

Original file line number	Diff line number	Diff line change
`@@ -418,7 +418,7 @@ <T extends CatalogType> GameRegistry registerModule(Class<T> catalogClass, Catal`
`418`	`418`	`/**`
`419`	`419`	`* Gets a locale for the specified locale code, e.g. {@code en_US}.`
`420`	`420`	`*`
`421`		`- * @param locale The locale to lookup (e.g. {@code en_US}.`
	`421`	`+ * @param locale The locale to lookup (e.g. {@code en_US}).`
`422`	`422`	`* @return The locale`
`423`	`423`	`*/`
`424`	`424`	`Locale getLocale(String locale);`
Original file line number	Diff line number	Diff line change
`@@ -273,7 +273,7 @@ public interface Server {`
`273`	`273`	`* Gets the 'server' scoreboard. In Vanilla, this is the scoreboard of`
`274`	`274`	`* dimension 0 (the overworld).`
`275`	`275`	`*`
`276`		`- * <p>The sever scoreboard is used with the Vanilla /scoreboard command,`
	`276`	`+ * <p>The server scoreboard is used with the Vanilla /scoreboard command,`
`277`	`277`	`* automatic score updating through criteria, and other things.</p>`
`278`	`278`	`*`
`279`	`279`	`* <p>The server scoreboard may not be available if dimension 0`
`@@ -356,8 +356,8 @@ public interface Server {`
`356`	`356`	`Text getMotd();`
`357`	`357`
`358`	`358`	`/**`
`359`		`- * Shuts down the server, and kicks all players with the default kic`
`360`		`- * k message.`
	`359`	`+ * Shuts down the server, and kicks all players with the default kick`
	`360`	`+ * message.`
`361`	`361`	`*`
`362`	`362`	`* <p>For the Sponge implementation on the client, this will trigger the`
`363`	`363`	`* Integrated Server to shutdown a tick later.</p>`
Original file line number	Diff line number	Diff line change
`@@ -2239,7 +2239,7 @@ public final class Keys {`
`2239`	`2239`	`* entities or collide with other entities.</p>`
`2240`	`2240`	`*`
`2241`	`2241`	`* <p>Vanishing an {@link Entity} ridden by other entities (see`
`2242`		`- * {@link #PASSENGERS} will cause problems.</p>`
	`2242`	`+ * {@link #PASSENGERS}) will cause problems.</p>`
`2243`	`2243`	`*`
`2244`	`2244`	`* @see Keys#VANISH`
`2245`	`2245`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`/**`
`34`	`34`	`* An {@link VariantData} for the {@link PortionType}. This has some mechanics`
`35`	`35`	`* with the partial bounding boxes for the actual blocks. Usually applicable`
`36`		`- * to {@link BlockTypes#DOUBLE_PLANT}, {@link BlockTypes#STONE_SLAB}`
	`36`	`+ * to {@link BlockTypes#DOUBLE_PLANT}, {@link BlockTypes#STONE_SLAB},`
`37`	`37`	`* {@link BlockTypes#WOODEN_DOOR}s, etc.`
`38`	`38`	`*`
`39`	`39`	`* @see Keys#PORTION_TYPE`