Pulling all pending Bukkit-JavaDoc changes

By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-04-02 00:11:22 -04:00
parent 745a0d7683
commit 761a84cb1b
93 changed files with 539 additions and 505 deletions

View File

@@ -36,7 +36,7 @@ public interface Block extends Metadatable {
/**
* Gets the block at the given face
* <p />
* <p>
* This method is equal to getRelative(face, 1)
*
* @param face Face of this block to return
@@ -47,7 +47,7 @@ public interface Block extends Metadatable {
/**
* Gets the block at the given distance of the given face
* <p />
* <p>
* For example, the following method places water at 100,102,100; two blocks
* above 100,100,100.
*
@@ -86,7 +86,7 @@ public interface Block extends Metadatable {
/**
* Get the amount of light at this block from the sky.
* <p />
* <p>
* Any light given from other sources (such as blocks like torches) will be ignored.
*
* @return Sky light level
@@ -95,7 +95,7 @@ public interface Block extends Metadatable {
/**
* Get the amount of light at this block from nearby blocks.
* <p />
* <p>
* Any light given from other sources (such as the sun) will be ignored.
*
* @return Block light level
@@ -203,7 +203,7 @@ public interface Block extends Metadatable {
/**
* Gets the face relation of this block compared to the given block
* <p />
* <p>
* For example:
* <pre>
* Block current = world.getBlockAt(100, 100, 100);
@@ -222,7 +222,7 @@ public interface Block extends Metadatable {
/**
* Captures the current state of this block. You may then cast that state
* into any accepted type, such as Furnace or Sign.
* <p />
* <p>
* The returned object will never be updated, and you are not guaranteed that
* (for example) a sign is still a sign after you capture its state.
*
@@ -291,7 +291,7 @@ public interface Block extends Metadatable {
/**
* Checks if this block is empty.
* <p />
* <p>
* A block is considered empty when {@link #getType()} returns {@link Material#AIR}.
*
* @return true if this block is empty
@@ -300,7 +300,7 @@ public interface Block extends Metadatable {
/**
* Checks if this block is liquid.
* <p />
* <p>
* A block is considered liquid when {@link #getType()} returns {@link Material#WATER}, {@link Material#STATIONARY_WATER}, {@link Material#LAVA} or {@link Material#STATIONARY_LAVA}.
*
* @return true if this block is liquid

View File

@@ -9,7 +9,7 @@ import org.bukkit.metadata.Metadatable;
/**
* Represents a captured state of a block, which will not change automatically.
* <p />
* <p>
* Unlike Block, which only one object can exist per coordinate, BlockState can
* exist multiple times for any given Block. Note that another plugin may change
* the state of the block and you will not know, or they may change the block to
@@ -127,7 +127,7 @@ public interface BlockState extends Metadatable {
/**
* Attempts to update the block represented by this state, setting it to the
* new values as defined by this state.
* <p />
* <p>
* This has the same effect as calling update(false). That is to say,
* this will not modify the state of a block if it is no longer the same
* type as it was when this state was taken. It will return false in this
@@ -141,7 +141,7 @@ public interface BlockState extends Metadatable {
/**
* Attempts to update the block represented by this state, setting it to the
* new values as defined by this state.
* <p />
* <p>
* This has the same effect as calling update(force, true). That is to say,
* this will trigger a physics update to surrounding blocks.
*
@@ -153,14 +153,14 @@ public interface BlockState extends Metadatable {
/**
* Attempts to update the block represented by this state, setting it to the
* new values as defined by this state.
* <p />
* <p>
* Unless force is true, this will not modify the state of a block if it is
* no longer the same type as it was when this state was taken. It will return
* false in this eventuality.
* <p />
* <p>
* If force is true, it will set the type of the block to match the new state,
* set the state data and then return true.
* <p />
* <p>
* If applyPhysics is true, it will trigger a physics update on surrounding
* blocks which could cause them to update or disappear.
*

View File

@@ -7,7 +7,7 @@ public interface Dispenser extends BlockState, ContainerBlock {
/**
* Attempts to dispense the contents of this block
* <p />
* <p>
* If the block is no longer a dispenser, this will return false
*
* @return true if successful, otherwise false

View File

@@ -9,14 +9,14 @@ public interface Dropper extends BlockState, InventoryHolder {
/**
* Tries to drop a randomly selected item from the Dropper's inventory,
* following the normal behavior of a Dropper.
* <p />
* <p>
* Normal behavior of a Dropper is as follows:
* <p />
* <p>
* If the block that the Dropper is facing is an InventoryHolder or
* ContainerBlock the randomly selected ItemStack is placed within that
* Inventory in the first slot that's available, starting with 0 and
* counting up. If the inventory is full, nothing happens.
* <p />
* <p>
* If the block that the Dropper is facing is not an InventoryHolder or
* ContainerBlock, the randomly selected ItemStack is dropped on
* the ground in the form of an {@link org.bukkit.entity.Item Item}.

View File

@@ -38,7 +38,7 @@ public interface NoteBlock extends BlockState {
/**
* Attempts to play the note at block
* <p />
* <p>
* If the block is no longer a note block, this will return false
*
* @return true if successful, otherwise false

View File

@@ -14,7 +14,7 @@ public interface Sign extends BlockState {
/**
* Gets the line of text at the specified index.
* <p />
* <p>
* For example, getLine(0) will return the first line of text.
*
* @param index Line number to get the text from, starting at 0
@@ -25,7 +25,7 @@ public interface Sign extends BlockState {
/**
* Sets the line of text at the specified index.
* <p />
* <p>
* For example, setLine(0, "Line One") will set the first line of text to
* "Line One".
*