More JavaDoc improvements.

This commit is contained in:
EvilSeph
2011-06-24 02:32:04 -04:00
parent b76de1ee24
commit a0c1f68109
56 changed files with 435 additions and 139 deletions

View File

@@ -6,10 +6,7 @@ import org.bukkit.event.Cancellable;
/**
* Triggered when a painting is removed
*
* @author Tanel Suurhans
*/
public class PaintingBreakEvent extends PaintingEvent implements Cancellable {
private boolean cancelled;
@@ -20,14 +17,31 @@ public class PaintingBreakEvent extends PaintingEvent implements Cancellable {
this.cause = cause;
}
/**
* Gets the cause for the painting's removal
*
* @return the RemoveCause for the painting's removal
*/
public RemoveCause getCause() {
return cause;
}
/**
* Gets the cancellation state of this event. A cancelled event will not
* be executed in the server, but will still pass to other plugins
*
* @return true if this event is cancelled
*/
public boolean isCancelled() {
return cancelled;
}
/**
* Sets the cancellation state of this event. A cancelled event will not
* be executed in the server, but will still pass to other plugins
*
* @param cancel true if you wish to cancel this event
*/
public void setCancelled(boolean cancel) {
this.cancelled = cancel;
}
@@ -36,13 +50,12 @@ public class PaintingBreakEvent extends PaintingEvent implements Cancellable {
* An enum to specify the cause of the removal
*/
public enum RemoveCause {
/**
* Removed by an entity
*/
ENTITY,
/**
* Removed by the world - block destroyed behind, water flowing over etc
* Removed by the world - block the painting is on is destroyed, water flowing over etc
*/
WORLD