Pulling all pending Bukkit-JavaDoc changes

By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot
2013-08-03 21:46:30 -04:00
parent b9642786eb
commit 599ec05858
80 changed files with 259 additions and 43 deletions

View File

@@ -39,6 +39,7 @@ public class CocoaPlant extends MaterialData implements Directional, Attachable
/**
* Get size of plant
*
* @return size
*/
public CocoaPlantSize getSize() {
@@ -54,6 +55,7 @@ public class CocoaPlant extends MaterialData implements Directional, Attachable
/**
* Set size of plant
*
* @param sz - size of plant
*/
public void setSize(CocoaPlantSize sz) {

View File

@@ -52,6 +52,7 @@ public class Mushroom extends MaterialData {
/**
* Checks whether a face of the block is painted.
*
* @param face The face to check.
* @return True if it is painted.
*/
@@ -81,6 +82,7 @@ public class Mushroom extends MaterialData {
/**
* Set a face of the block to be painted or not. Note that due to the nature of how the data is stored,
* setting a face painted or not is not guaranteed to leave the other faces unchanged.
*
* @param face The face to paint or unpaint.
* @param painted True if you want to paint it, false if you want the pores to show.
*/

View File

@@ -26,6 +26,7 @@ public class SpawnEgg extends MaterialData {
/**
* Get the type of entity this egg will spawn.
*
* @return The entity type.
*/
public EntityType getSpawnedType() {
@@ -34,6 +35,7 @@ public class SpawnEgg extends MaterialData {
/**
* Set the type of entity this egg will spawn.
*
* @param type The entity type.
*/
public void setSpawnedType(EntityType type) {

View File

@@ -90,6 +90,7 @@ public class Stairs extends MaterialData implements Directional {
/**
* Test if step is inverted
*
* @return true if inverted (top half), false if normal (bottom half)
*/
public boolean isInverted() {
@@ -98,6 +99,7 @@ public class Stairs extends MaterialData implements Directional {
/**
* Set step inverted state
*
* @param inv - true if step is inverted (top half), false if step is normal (bottom half)
*/
public void setInverted(boolean inv) {

View File

@@ -49,6 +49,7 @@ public class Step extends TexturedMaterial {
/**
* Test if step is inverted
*
* @return true if inverted (top half), false if normal (bottom half)
*/
public boolean isInverted() {
@@ -57,6 +58,7 @@ public class Step extends TexturedMaterial {
/**
* Set step inverted state
*
* @param inv - true if step is inverted (top half), false if step is normal (bottom half)
*/
public void setInverted(boolean inv) {

View File

@@ -62,6 +62,7 @@ public abstract class TexturedMaterial extends MaterialData {
/**
* Get material index from data
*
* @return index of data in textures list
*/
protected int getTextureIndex() {
@@ -70,6 +71,7 @@ public abstract class TexturedMaterial extends MaterialData {
/**
* Set material index
*
* @param idx - index of data in textures list
*/
protected void setTextureIndex(int idx) {

View File

@@ -45,6 +45,7 @@ public class TrapDoor extends SimpleAttachableMaterialData implements Openable {
/**
* Test if trapdoor is inverted
*
* @return true if inverted (top half), false if normal (bottom half)
*/
public boolean isInverted() {
@@ -53,6 +54,7 @@ public class TrapDoor extends SimpleAttachableMaterialData implements Openable {
/**
* Set trapdoor inverted state
*
* @param inv - true if inverted (top half), false if normal (bottom half)
*/
public void setInverted(boolean inv) {

View File

@@ -77,6 +77,7 @@ public class Tree extends MaterialData {
}
/**
* Set direction of the log
*
* @param dir - direction of end of log (BlockFace.SELF for no direction)
*/
public void setDirection(BlockFace dir) {

View File

@@ -21,6 +21,7 @@ public class Tripwire extends MaterialData {
/**
* Test if tripwire is currently activated
*
* @return true if activated, false if not
*/
public boolean isActivated() {
@@ -29,6 +30,7 @@ public class Tripwire extends MaterialData {
/**
* Set tripwire activated state
*
* @param act - true if activated, false if not
*/
public void setActivated(boolean act) {
@@ -41,6 +43,7 @@ public class Tripwire extends MaterialData {
/**
* Test if object triggering this tripwire directly
*
* @return true if object activating tripwire, false if not
*/
public boolean isObjectTriggering() {
@@ -49,6 +52,7 @@ public class Tripwire extends MaterialData {
/**
* Set object triggering state for this tripwire
*
* @param trig - true if object activating tripwire, false if not
*/
public void setObjectTriggering(boolean trig) {

View File

@@ -27,6 +27,7 @@ public class TripwireHook extends SimpleAttachableMaterialData implements Redsto
/**
* Test if tripwire is connected
*
* @return true if connected, false if not
*/
public boolean isConnected() {
@@ -35,6 +36,7 @@ public class TripwireHook extends SimpleAttachableMaterialData implements Redsto
/**
* Set tripwire connection state
*
* @param connected - true if connected, false if not
*/
public void setConnected(boolean connected) {
@@ -47,6 +49,7 @@ public class TripwireHook extends SimpleAttachableMaterialData implements Redsto
/**
* Test if hook is currently activated
*
* @return true if activated, false if not
*/
public boolean isActivated() {
@@ -55,6 +58,7 @@ public class TripwireHook extends SimpleAttachableMaterialData implements Redsto
/**
* Set hook activated state
*
* @param act - true if activated, false if not
*/
public void setActivated(boolean act) {

View File

@@ -55,6 +55,7 @@ public class WoodenStep extends MaterialData {
/**
* Test if step is inverted
*
* @return true if inverted (top half), false if normal (bottom half)
*/
public boolean isInverted() {
@@ -63,6 +64,7 @@ public class WoodenStep extends MaterialData {
/**
* Set step inverted state
*
* @param inv - true if step is inverted (top half), false if step is normal (bottom half)
*/
public void setInverted(boolean inv) {