Pulling all pending Bukkit-JavaDoc changes

This commit is contained in:
Edmond Poon 2013-03-27 21:12:08 -04:00
parent 2bb16b29ab
commit bde69789d3
3 changed files with 23 additions and 3 deletions

View File

@ -30,14 +30,14 @@ public interface Skull extends BlockState {
public boolean setOwner(String name); public boolean setOwner(String name);
/** /**
* Gets the rotation of the skull * Gets the rotation of the skull in the world
* *
* @return the rotation of the skull * @return the rotation of the skull
*/ */
public BlockFace getRotation(); public BlockFace getRotation();
/** /**
* Sets the rotation of the skull * Sets the rotation of the skull in the world
* *
* @param rotation the rotation of the skull * @param rotation the rotation of the skull
*/ */

View File

@ -176,7 +176,7 @@ public abstract class Enchantment {
/** /**
* Checks if this Enchantment may be applied to the given {@link ItemStack}. * Checks if this Enchantment may be applied to the given {@link ItemStack}.
* This does not check if it conflicts with any enchantmentds already applied to the item. * This does not check if it conflicts with any enchantments already applied to the item.
* *
* @param item Item to test * @param item Item to test
* @return True if the enchantment may be applied, otherwise False * @return True if the enchantment may be applied, otherwise False

View File

@ -11,7 +11,27 @@ import java.lang.annotation.Target;
@Target(ElementType.METHOD) @Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)
public @interface EventHandler { public @interface EventHandler {
/**
* Define the priority of the event.
* <p />
* First priority to the last priority executed:
* <ol>
* <li>LOWEST</li>
* <li>LOW</li>
* <li>NORMAL</li>
* <li>HIGH</li>
* <li>HIGHEST</li>
* <li>MONITOR</li>
* </ol>
*/
EventPriority priority() default EventPriority.NORMAL; EventPriority priority() default EventPriority.NORMAL;
/**
* Define if the handler ignores a cancelled event.
* <p />
* If ignoreCancelled is true and the event is cancelled, the method is
* not called. Otherwise, the method is always called.
*/
boolean ignoreCancelled() default false; boolean ignoreCancelled() default false;
} }