Clean up the javadoc to pass java 8's doclint

By: Thinkofdeath <thinkofdeath@spigotmc.org>
This commit is contained in:
Bukkit/Spigot
2014-11-30 21:09:01 +00:00
parent 8344aacc6e
commit b2d54f59bb
156 changed files with 1155 additions and 501 deletions

View File

@@ -29,6 +29,9 @@ public class BlockCanBuildEvent extends BlockEvent {
/**
*
* @deprecated Magic value
* @param block the block involved in this event
* @param id the id of the block to place
* @param canBuild whether we can build
*/
@Deprecated
public BlockCanBuildEvent(final Block block, final int id, final boolean canBuild) {

View File

@@ -19,10 +19,6 @@ public class BlockIgniteEvent extends BlockEvent implements Cancellable {
private final Block ignitingBlock;
private boolean cancel;
/**
* @deprecated use {@link BlockIgniteEvent#BlockIgniteEvent(Block,
* IgniteCause, Entity)} instead.
*/
@Deprecated
public BlockIgniteEvent(final Block theBlock, final IgniteCause cause, final Player thePlayer) {
this(theBlock, cause, (Entity) thePlayer);

View File

@@ -16,6 +16,8 @@ public class BlockPhysicsEvent extends BlockEvent implements Cancellable {
/**
*
* @deprecated Magic value
* @param block the block involved in this event
* @param changed the changed block's type id
*/
@Deprecated
public BlockPhysicsEvent(final Block block, final int changed) {

View File

@@ -46,8 +46,8 @@ public class SignChangeEvent extends BlockEvent implements Cancellable {
* @param index index of the line to get
* @return the String containing the line of text associated with the
* provided index
* @throws IndexOutOfBoundsException thrown when the provided index is > 3
* or < 0
* @throws IndexOutOfBoundsException thrown when the provided index is {@literal > 3
* or < 0}
*/
public String getLine(int index) throws IndexOutOfBoundsException {
return lines[index];
@@ -58,8 +58,8 @@ public class SignChangeEvent extends BlockEvent implements Cancellable {
*
* @param index index of the line to set
* @param line text to set
* @throws IndexOutOfBoundsException thrown when the provided index is > 3
* or < 0
* @throws IndexOutOfBoundsException thrown when the provided index is {@literal > 3
* or < 0}
*/
public void setLine(int index, String line) throws IndexOutOfBoundsException {
lines[index] = line;