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

@@ -23,6 +23,7 @@ public class Potion {
* Construct a new potion of the given type. Unless the type is {@link PotionType#WATER},
* it will be level one, without extended duration. Don't use this constructor to create
* a no-effect potion other than water bottle.
*
* @param type The potion type
* @see #Potion(int)
*/
@@ -61,6 +62,7 @@ public class Potion {
/**
* Create a new potion of the given type and level.
*
* @param type The type of potion.
* @param level The potion's level.
*/
@@ -74,6 +76,7 @@ public class Potion {
/**
* Create a new potion of the given type and level.
*
* @param type The type of potion.
* @param level The potion's level.
* @param splash Whether it is a splash potion.
@@ -87,6 +90,7 @@ public class Potion {
/**
* Create a new potion of the given type and level.
*
* @param type The type of potion.
* @param level The potion's level.
* @param splash Whether it is a splash potion.
@@ -102,6 +106,7 @@ public class Potion {
/**
* Create a potion with a specific name.
*
* @param name The name index (0-63)
*/
public Potion(int name) {
@@ -115,6 +120,7 @@ public class Potion {
/**
* Chain this to the constructor to make the potion a splash potion.
*
* @return The potion.
*/
public Potion splash() {
@@ -124,6 +130,7 @@ public class Potion {
/**
* Chain this to the constructor to extend the potion's duration.
*
* @return The potion.
*/
public Potion extend() {

View File

@@ -126,6 +126,7 @@ public class PotionEffect implements ConfigurationSerializable {
* Returns the amplifier of this effect. A higher amplifier means the potion
* effect happens more often over its duration and in some cases has more
* effect on its target.
*
* @return The effect amplifier
*/
public int getAmplifier() {
@@ -135,6 +136,7 @@ public class PotionEffect implements ConfigurationSerializable {
/**
* Returns the duration (in ticks) that this effect will run for when
* applied to a {@link LivingEntity}.
*
* @return The duration of the effect
*/
public int getDuration() {

View File

@@ -17,6 +17,7 @@ public class PotionEffectTypeWrapper extends PotionEffectType {
/**
* Get the potion type bound to this wrapper.
*
* @return The potion effect type
*/
public PotionEffectType getType() {