Fix javadoc errors/warnings

By: Celtic Minstrel <celtic.minstrel.ca@some.place>
This commit is contained in:
Bukkit/Spigot
2012-02-26 10:35:17 -05:00
parent 5ebb8d2b3e
commit 795a61bbeb
28 changed files with 79 additions and 65 deletions

View File

@@ -23,7 +23,7 @@ public interface Boat extends Vehicle {
* Gets the deceleration rate (newSpeed = curSpeed * rate) of occupied
* boats. The default is 0.2.
*
* @return
* @return The rate of deceleration
*/
public double getOccupiedDeceleration();
@@ -32,7 +32,7 @@ public interface Boat extends Vehicle {
* boats. Setting this to a higher value allows for quicker acceleration.
* The default is 0.2.
*
* @param speed deceleration rate
* @param rate deceleration rate
*/
public void setOccupiedDeceleration(double rate);
@@ -41,7 +41,7 @@ public interface Boat extends Vehicle {
* boats. The default is -1. Values below 0 indicate that no additional
* deceleration is imposed.
*
* @return
* @return The rate of deceleration
*/
public double getUnoccupiedDeceleration();

View File

@@ -57,7 +57,7 @@ public interface Entity extends Metadatable {
* Teleports this entity to the given location
*
* @param location New location to teleport this entity to
* @praram cause The cause of this teleportation
* @param cause The cause of this teleportation
* @return <code>true</code> if the teleport was successful
*/
public boolean teleport(Location location, TeleportCause cause);
@@ -74,7 +74,7 @@ public interface Entity extends Metadatable {
* Teleports this entity to the target Entity
*
* @param destination Entity to teleport this entity to
* @praram cause The cause of this teleportation
* @param cause The cause of this teleportation
* @return <code>true</code> if the teleport was successful
*/
public boolean teleport(Entity destination, TeleportCause cause);

View File

@@ -3,6 +3,7 @@ package org.bukkit.entity;
import java.util.HashMap;
import java.util.Map;
import org.bukkit.Location;
import org.bukkit.World;
public enum EntityType {
@@ -120,7 +121,8 @@ public enum EntityType {
}
/**
* Some entities cannot be spawned using {@link World#spawn(org.bukkit.Location, EntityType)}, usually
* Some entities cannot be spawned using {@link World#spawnCreature(Location, EntityType)}
* or {@link World#spawn(Location, Class)}, usually
* because they require additional information in order to spawn.
* @return False if the entity type cannot be spawned
*/

View File

@@ -252,6 +252,7 @@ public interface LivingEntity extends Entity {
* effect of the given {@link PotionEffectType} applied to it.
*
* @param type The potion type to check
* @return Whether the player has this potion effect active on them.
*/
public boolean hasPotionEffect(PotionEffectType type);

View File

@@ -10,6 +10,7 @@ import org.bukkit.potion.PotionEffect;
public interface ThrownPotion extends Projectile {
/**
* Returns the effects that are applied by this potion.
* @return The potion effects
*/
public Collection<PotionEffect> getEffects();
}