Fix upstream javadocs

This commit is contained in:
Zach Brown
2017-06-10 16:59:40 -05:00
parent f7eff332be
commit 0c37d20354
75 changed files with 403 additions and 173 deletions

View File

@@ -4,7 +4,22 @@ import org.bukkit.material.Colorable;
/**
* Represents a captured state of a bed.
* @deprecated does not provide useful information beyond the material itself
*/
@Deprecated(since = "1.13")
public interface Bed extends TileState, Colorable { }
// Paper start
// @Deprecated(since = "1.13")
public interface Bed extends TileState, Colorable {
@Override
@org.jetbrains.annotations.NotNull org.bukkit.DyeColor getColor();
/**
* <b>Unsupported</b>
*
* @throws UnsupportedOperationException not supported, set the block type
*/
@Override
@org.jetbrains.annotations.Contract("_ -> fail")
@Deprecated(forRemoval = true)
void setColor(@org.bukkit.UndefinedNullability("not supported") org.bukkit.DyeColor color);
// Paper end
}

View File

@@ -357,7 +357,7 @@ public interface Block extends Metadatable, Translatable {
* Gets the temperature of this block.
* <p>
* If the raw biome temperature without adjusting for height effects is
* required then please use {@link World#getTemperature(int, int)}.
* required then please use {@link World#getTemperature(int, int, int)}.
*
* @return Temperature of this block
*/
@@ -405,7 +405,10 @@ public interface Block extends Metadatable, Translatable {
boolean applyBoneMeal(@NotNull BlockFace face);
/**
* Returns a list of items which would drop by destroying this block
* Returns a list of items which could drop by destroying this block.
* <p>
* The items are not guaranteed to be consistent across multiple calls to this
* method as this just uses the block type's loot table.
*
* @return a list of dropped items for this type of block
*/
@@ -413,8 +416,11 @@ public interface Block extends Metadatable, Translatable {
Collection<ItemStack> getDrops();
/**
* Returns a list of items which would drop by destroying this block with
* a specific tool
* Returns a list of items which could drop by destroying this block with
* a specific tool.
* <p>
* The items are not guaranteed to be consistent across multiple calls to this
* method as this just uses the block type's loot table.
*
* @param tool The tool or item in hand used for digging
* @return a list of dropped items for this type of block
@@ -423,8 +429,11 @@ public interface Block extends Metadatable, Translatable {
Collection<ItemStack> getDrops(@Nullable ItemStack tool);
/**
* Returns a list of items which would drop by the entity destroying this
* block with a specific tool
* Returns a list of items which could drop by the entity destroying this
* block with a specific tool.
* <p>
* The items are not guaranteed to be consistent across multiple calls to this
* method as this just uses the block type's loot table.
*
* @param tool The tool or item in hand used for digging
* @param entity the entity destroying the block

View File

@@ -224,7 +224,7 @@ public interface BlockData extends Cloneable {
* {@link Material#REDSTONE_WIRE} -> {@link Material#REDSTONE}
* {@link Material#CARROTS} -> {@link Material#CARROT}
* </pre>
* @return placement material
* @return placement material or {@link Material#AIR} if it doesn't have one
*/
@NotNull
Material getPlacementMaterial();

View File

@@ -38,7 +38,7 @@ public interface FaceAttachable extends BlockData {
*/
WALL,
/**
* The switch is mounted to the ceiling and pointing dowanrds.
* The switch is mounted to the ceiling and pointing downwards.
*/
CEILING;
}

View File

@@ -4,7 +4,7 @@ import org.bukkit.block.data.Directional;
/**
* 'conditional' denotes whether this command block is conditional or not, i.e.
* will only execute if the preceeding command block also executed successfully.
* will only execute if the preceding command block also executed successfully.
*/
public interface CommandBlock extends Directional {

View File

@@ -5,7 +5,7 @@ import org.bukkit.block.data.Openable;
import org.bukkit.block.data.Powerable;
/**
* 'in_wall" indicates if the fence gate is attached to a wall, and if true the
* 'in_wall' indicates if the fence gate is attached to a wall, and if true the
* texture is lowered by a small amount to blend in better.
*/
public interface Gate extends Directional, Openable, Powerable {

View File

@@ -21,7 +21,7 @@ public interface Switch extends Directional, FaceAttachable, Powerable {
* Sets the value of the 'face' property.
*
* @param face the new 'face' value
* @deprecated use {@link #getAttachedFace()}
* @deprecated use {@link #setAttachedFace(AttachedFace)}
*/
@Deprecated(since = "1.15.2")
void setFace(@NotNull Face face);
@@ -42,7 +42,7 @@ public interface Switch extends Directional, FaceAttachable, Powerable {
*/
WALL,
/**
* The switch is mounted to the ceiling and pointing dowanrds.
* The switch is mounted to the ceiling and pointing downwards.
*/
CEILING;
}