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 ExpBottleEvent extends ProjectileHitEvent {
/**
* This method indicates if the particle effect should be shown.
*
* @return true if the effect will be shown, false otherwise
*/
public boolean getShowEffect() {
@@ -32,6 +33,7 @@ public class ExpBottleEvent extends ProjectileHitEvent {
/**
* This method sets if the particle effect will be shown.
* This does not change the experience created.
*
* @param showEffect
* true indicates the effect will be shown,
* false indicates no effect will be shown
@@ -43,6 +45,7 @@ public class ExpBottleEvent extends ProjectileHitEvent {
/**
* This method retrieves the amount of experience to be created.
* The number indicates a total amount to be divided into orbs.
*
* @return the total amount of experience to be created
*/
public int getExperience() {
@@ -52,6 +55,7 @@ public class ExpBottleEvent extends ProjectileHitEvent {
/**
* This method sets the amount of experience to be created.
* The number indicates a total amount to be divided into orbs.
*
* @param exp the total amount of experience to be created
*/
public void setExperience(final int exp) {