Javadoc improvements per checkstyle

By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot
2019-12-22 09:56:28 +11:00
parent d419ccca3f
commit d16413b877
96 changed files with 181 additions and 48 deletions

View File

@@ -10,26 +10,23 @@ import org.jetbrains.annotations.Nullable;
public interface Campfire extends TileState {
/**
* @see Inventory#getSize()
*
* @return The size of the inventory
* @see Inventory#getSize()
*/
int getSize();
/**
* @see Inventory#getItem(int)
*
* @param index The index of the Slot's ItemStack to return
* @return The ItemStack in the slot
* @see Inventory#getItem(int)
*/
@Nullable
ItemStack getItem(int index);
/**
* @see Inventory#setItem(int, org.bukkit.inventory.ItemStack)
*
* @param index The index where to put the ItemStack
* @param item The ItemStack to set
* @see Inventory#setItem(int, org.bukkit.inventory.ItemStack)
*/
void setItem(int index, @Nullable ItemStack item);

View File

@@ -78,8 +78,8 @@ public interface CreatureSpawner extends TileState {
/**
* Set the minimum spawn delay amount (in ticks).
*
* @see #getMinSpawnDelay()
* @param delay the minimum spawn delay amount
* @see #getMinSpawnDelay()
*/
public void setMinSpawnDelay(int delay);
@@ -105,8 +105,8 @@ public interface CreatureSpawner extends TileState {
* This value <b>must</b> be greater than 0, as well as greater than or
* equal to {@link #getMinSpawnDelay()}
*
* @see #getMaxSpawnDelay()
* @param delay the new maximum spawn delay amount
* @see #getMaxSpawnDelay()
*/
public void setMaxSpawnDelay(int delay);
@@ -195,8 +195,8 @@ public interface CreatureSpawner extends TileState {
* Set the new spawn range.
* <br>
*
* @see #getSpawnRange()
* @param spawnRange the new spawn range
* @see #getSpawnRange()
*/
public void setSpawnRange(int spawnRange);
}

View File

@@ -0,0 +1,4 @@
/**
* Classes relevant to banner blocks.
*/
package org.bukkit.block.banner;

View File

@@ -0,0 +1,4 @@
/**
* Generalized BlockData classes.
*/
package org.bukkit.block.data;

View File

@@ -0,0 +1,4 @@
/**
* Specific BlockData classes relevant to only a given block or set of blocks.
*/
package org.bukkit.block.data.type;

View File

@@ -0,0 +1,6 @@
/**
* Classes used to manipulate the voxels in a {@link org.bukkit.World world},
* including special states.
*/
package org.bukkit.block;

View File

@@ -0,0 +1,4 @@
/**
* Classes relevant to structure blocks.
*/
package org.bukkit.block.structure;