More JavaDoc improvements.

This commit is contained in:
EvilSeph
2011-07-15 01:15:05 -04:00
parent 7968683662
commit 9789918954
28 changed files with 335 additions and 161 deletions

View File

@@ -6,7 +6,6 @@ import org.bukkit.event.Cancellable;
/**
* Called when an entity interacts with an object
*
*/
public class EntityInteractEvent extends EntityEvent implements Cancellable {
protected Block block;
@@ -22,7 +21,7 @@ public class EntityInteractEvent extends EntityEvent implements Cancellable {
* Gets the cancellation state of this event. Set to true if you
* want to prevent buckets from placing water and so forth
*
* @return boolean cancellation state
* @return true if this event is cancelled
*/
public boolean isCancelled() {
return cancelled;
@@ -32,10 +31,6 @@ public class EntityInteractEvent extends EntityEvent implements Cancellable {
* Sets the cancellation state of this event. A canceled event will not
* be executed in the server, but will still pass to other plugins
*
* Canceling this event will prevent use of food (player won't lose the
* food item), prevent bows/snowballs/eggs from firing, etc. (player won't
* lose the ammo)
*
* @param cancel true if you wish to cancel this event
*/
public void setCancelled(boolean cancel) {
@@ -45,7 +40,7 @@ public class EntityInteractEvent extends EntityEvent implements Cancellable {
/**
* Returns the involved block
*
* @return Block returns the block clicked with this item.
* @return the block clicked with this item.
*/
public Block getBlock() {
return block;