SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
A special thanks goes to @aerouk for almost all of the changes found here.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
paper-api/src/main/java/org/bukkit/potion/Potion.java
View File

@@ -20,9 +20,10 @@ public class Potion {
private PotionType type;
/**
* 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.
* 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)
@@ -57,7 +58,8 @@ public class Potion {
}
/**
* @deprecated In favour of {@link #Potion(PotionType, int, boolean, boolean)}
* @deprecated In favour of {@link #Potion(PotionType, int, boolean,
* boolean)}
*/
@SuppressWarnings("javadoc")
@Deprecated
@@ -86,7 +88,8 @@ public class Potion {
* @param type The type of potion.
* @param level The potion's level.
* @param splash Whether it is a splash potion.
* @deprecated In favour of using {@link #Potion(PotionType)} with {@link #splash()}.
* @deprecated In favour of using {@link #Potion(PotionType)} with {@link
* #splash()}.
*/
@Deprecated
public Potion(PotionType type, int level, boolean splash) {
@@ -101,8 +104,8 @@ public class Potion {
* @param level The potion's level.
* @param splash Whether it is a splash potion.
* @param extended Whether it has an extended duration.
* @deprecated In favour of using {@link #Potion(PotionType)} with {@link #extend()}
* and possibly {@link #splash()}.
* @deprecated In favour of using {@link #Potion(PotionType)} with {@link
* #extend()} and possibly {@link #splash()}.
*/
@Deprecated
public Potion(PotionType type, int level, boolean splash, boolean extended) {
@@ -146,7 +149,7 @@ public class Potion {
/**
* Applies the effects of this potion to the given {@link ItemStack}. The
* itemstack must be a potion.
* ItemStack must be a potion.
*
* @param to The itemstack to apply to
*/
@@ -250,8 +253,8 @@ public class Potion {
}
/**
* Set whether this potion has extended duration. This will cause the potion
* to have roughly 8/3 more duration than a regular potion.
* Set whether this potion has extended duration. This will cause the
* potion to have roughly 8/3 more duration than a regular potion.
*
* @param isExtended Whether the potion should have extended duration
*/
@@ -261,11 +264,10 @@ public class Potion {
}
/**
* Sets whether this potion is a splash potion. Splash potions can be thrown
* for a radius effect.
* Sets whether this potion is a splash potion. Splash potions can be
* thrown for a radius effect.
*
* @param isSplash
* Whether this is a splash potion
* @param isSplash Whether this is a splash potion
*/
public void setSplash(boolean isSplash) {
splash = isSplash;
@@ -286,8 +288,7 @@ public class Potion {
/**
* Sets the {@link PotionType} of this potion.
*
* @param type
* The new type of this potion
* @param type The new type of this potion
*/
public void setType(PotionType type) {
this.type = type;

4
paper-api/src/main/java/org/bukkit/potion/PotionBrewer.java
View File

@@ -19,8 +19,8 @@ public interface PotionBrewer {
public PotionEffect createEffect(PotionEffectType potion, int duration, int amplifier);
/**
* Returns a collection of {@link PotionEffect} that would be applied from a
* potion with the given data value.
* Returns a collection of {@link PotionEffect} that would be applied from
* a potion with the given data value.
*
* @param damage The data value of the potion
* @return The list of effects

9
paper-api/src/main/java/org/bukkit/potion/PotionEffect.java
View File

@@ -31,7 +31,8 @@ public class PotionEffect implements ConfigurationSerializable {
* Creates a potion effect.
*
* @param type effect type
* @param duration measured in ticks, see {@link PotionEffect#getDuration()}
* @param duration measured in ticks, see {@link
* PotionEffect#getDuration()}
* @param amplifier the amplifier, see {@link PotionEffect#getAmplifier()}
* @param ambient the ambient status, see {@link PotionEffect#isAmbient()}
*/
@@ -123,9 +124,9 @@ 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.
* 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
*/

6
paper-api/src/main/java/org/bukkit/potion/PotionEffectType.java
View File

@@ -105,7 +105,8 @@ public abstract class PotionEffectType {
public static final PotionEffectType POISON = new PotionEffectTypeWrapper(19);
/**
* Deals damage to an entity over time and gives the health to the shooter.
* Deals damage to an entity over time and gives the health to the
* shooter.
*/
public static final PotionEffectType WITHER = new PotionEffectTypeWrapper(20);
@@ -132,7 +133,8 @@ public abstract class PotionEffectType {
}
/**
* Creates a PotionEffect from this PotionEffectType, applying duration modifiers and checks.
* Creates a PotionEffect from this PotionEffectType, applying duration
* modifiers and checks.
*
* @see PotionBrewer#createEffect(PotionEffectType, int, int)
* @param duration time in ticks