Many javadoc fixes thanks to Celtic Minstrel

By: Dinnerbone <dinnerbone@dinnerbone.com>
This commit is contained in:
Bukkit/Spigot
2011-09-25 02:56:40 +01:00
parent 1968b78a12
commit a8e72bdb91
78 changed files with 380 additions and 335 deletions

View File

@@ -19,34 +19,35 @@ public interface Minecart extends Vehicle {
/**
* Gets a minecart's damage.
*
* @param damage
* @return The damage
*/
public int getDamage();
/**
* Gets the maximum speed of a minecart. The speed is unrelated to the velocity.
*
* @param speed
*
* @return The max speed
*/
public double getMaxSpeed();
/**
* Sets the maximum speed of a minecart. Must be nonnegative. Default is 0.4D.
*
* @param speed
* @param speed The max speed
*/
public void setMaxSpeed(double speed);
/**
* Returns whether this minecart will slow down faster without a passenger occupying it
*
* @return Whether it decelerates faster
*/
public boolean isSlowWhenEmpty();
/**
* Sets whether this minecart will slow down faster without a passenger occupying it
*
* @param slow
* @param slow Whether it will decelerate faster
*/
public void setSlowWhenEmpty(boolean slow);
@@ -54,7 +55,7 @@ public interface Minecart extends Vehicle {
* Gets the flying velocity modifier. Used for minecarts that are in mid-air.
* A flying minecart's velocity is multiplied by this factor each tick.
*
* @param flying velocity modifier
* @return The vector factor
*/
public Vector getFlyingVelocityMod();
@@ -62,7 +63,7 @@ public interface Minecart extends Vehicle {
* Sets the flying velocity modifier. Used for minecarts that are in mid-air.
* A flying minecart's velocity is multiplied by this factor each tick.
*
* @param flying velocity modifier
* @param flying velocity modifier vector
*/
public void setFlyingVelocityMod(Vector flying);
@@ -70,7 +71,7 @@ public interface Minecart extends Vehicle {
* Gets the derailed velocity modifier. Used for minecarts that are on the ground, but not on rails.
*
* A derailed minecart's velocity is multiplied by this factor each tick.
* @param visible speed
* @return derailed visible speed
*/
public Vector getDerailedVelocityMod();
@@ -78,7 +79,7 @@ public interface Minecart extends Vehicle {
* Sets the derailed velocity modifier. Used for minecarts that are on the ground, but not on rails.
* A derailed minecart's velocity is multiplied by this factor each tick.
*
* @param visible speed
* @param derailed visible speed
*/
public void setDerailedVelocityMod(Vector derailed);
}