Adding/expanding documentation

By: Celtic Minstrel <celtic.minstrel.ca@some.place>
This commit is contained in:
Bukkit/Spigot
2012-02-26 12:13:30 -05:00
parent 795a61bbeb
commit 15e2f69fa6
20 changed files with 162 additions and 16 deletions

View File

@@ -1,6 +1,6 @@
package org.bukkit.entity;
/**
* Represents an egg.
* Represents a thrown egg.
*/
public interface Egg extends Projectile {}

View File

@@ -1,7 +1,7 @@
package org.bukkit.entity;
/**
* Represents an Ender Pearl entity
* Represents a thrown Ender Pearl entity
*/
public interface EnderPearl extends Projectile {

View File

@@ -18,7 +18,7 @@ public enum EntityType {
ENDER_PEARL("ThrownEnderpearl", EnderPearl.class, 14),
ENDER_SIGNAL("EyeOfEnderSignal", EnderSignal.class, 15),
PRIMED_TNT("PrimedTnt", TNTPrimed.class, 20),
FALLING_BLOCK("FallingBlock", FallingSand.class, 21, false),
FALLING_BLOCK("FallingSand", FallingSand.class, 21, false),
MINECART("Minecart", Minecart.class, 40),
BOAT("Boat", Boat.class, 41),
CREEPER("Creeper", Creeper.class, 50),

View File

@@ -1,6 +1,6 @@
package org.bukkit.entity;
/**
* Represents Falling Sand.
* Represents a falling block.
*/
public interface FallingSand extends Entity {}

View File

@@ -1,6 +1,6 @@
package org.bukkit.entity;
/**
* Represents a Fish.
* Represents a fishing hook.
*/
public interface Fish extends Projectile {}

View File

@@ -2,6 +2,7 @@ package org.bukkit.entity;
import org.bukkit.Art;
import org.bukkit.block.BlockFace;
import org.bukkit.event.painting.PaintingBreakEvent;
import org.bukkit.material.Attachable;
/**
@@ -29,7 +30,7 @@ public interface Painting extends Entity, Attachable {
* @param art The new art
* @param force If true, force the new art regardless of whether it fits at the current location
* Note that forcing it where it can't fit normally causes it to drop as an item unless you override
* this by catching the PAINTING_BREAK event.
* this by catching the {@link PaintingBreakEvent}.
* @return False if force was false and the new art won't fit at the painting's current location
*/
public boolean setArt(Art art, boolean force);

View File

@@ -6,13 +6,11 @@ package org.bukkit.entity;
public interface Slime extends LivingEntity {
/**
* @author Celtic Minstrel
* @return The size of the slime
*/
public int getSize();
/**
* @author Celtic Minstrel
* @param sz The new size of the slime.
*/
public void setSize(int sz);

View File

@@ -1,6 +1,6 @@
package org.bukkit.entity;
/**
* Implements a snowball.
* Represents a snowball.
*/
public interface Snowball extends Projectile {}