diff options
author | Wesley Wolfe <weswolf@aol.com> | 2013-12-15 01:07:43 -0500 |
---|---|---|
committer | Wesley Wolfe <weswolf@aol.com> | 2013-12-15 01:09:18 -0500 |
commit | d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5 (patch) | |
tree | 52ad0a3c379beb3fa5d8b0f368b0ade6649b8459 /src/main/java/org/bukkit/event/world | |
parent | 49a400e44a10dfdbccea86a1c76fb94ab2e666bf (diff) | |
download | bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.tar bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.tar.gz bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.tar.lz bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.tar.xz bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.zip |
Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here.
Diffstat (limited to 'src/main/java/org/bukkit/event/world')
6 files changed, 18 insertions, 8 deletions
diff --git a/src/main/java/org/bukkit/event/world/ChunkLoadEvent.java b/src/main/java/org/bukkit/event/world/ChunkLoadEvent.java index 906fa43d..a45b1cd4 100644 --- a/src/main/java/org/bukkit/event/world/ChunkLoadEvent.java +++ b/src/main/java/org/bukkit/event/world/ChunkLoadEvent.java @@ -17,6 +17,7 @@ public class ChunkLoadEvent extends ChunkEvent { /** * Gets if this chunk was newly created or not. + * <p> * Note that if this chunk is new, it will not be populated at this time. * * @return true if the chunk is new, otherwise false diff --git a/src/main/java/org/bukkit/event/world/ChunkPopulateEvent.java b/src/main/java/org/bukkit/event/world/ChunkPopulateEvent.java index 71106f37..705d9556 100644 --- a/src/main/java/org/bukkit/event/world/ChunkPopulateEvent.java +++ b/src/main/java/org/bukkit/event/world/ChunkPopulateEvent.java @@ -7,7 +7,8 @@ import org.bukkit.generator.BlockPopulator; /** * Thrown when a new chunk has finished being populated. * <p> - * If your intent is to populate the chunk using this event, please see {@link BlockPopulator} + * If your intent is to populate the chunk using this event, please see {@link + * BlockPopulator} */ public class ChunkPopulateEvent extends ChunkEvent { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/world/PortalCreateEvent.java b/src/main/java/org/bukkit/event/world/PortalCreateEvent.java index 6f1183a7..d83d7a99 100644 --- a/src/main/java/org/bukkit/event/world/PortalCreateEvent.java +++ b/src/main/java/org/bukkit/event/world/PortalCreateEvent.java @@ -64,11 +64,13 @@ public class PortalCreateEvent extends WorldEvent implements Cancellable { */ public enum CreateReason { /** - * When a portal is created 'traditionally' due to a portal frame being set on fire. + * When a portal is created 'traditionally' due to a portal frame + * being set on fire. */ FIRE, /** - * When a portal is created as a destination for an existing portal when using the custom PortalTravelAgent + * When a portal is created as a destination for an existing portal + * when using the custom PortalTravelAgent */ OBC_DESTINATION } diff --git a/src/main/java/org/bukkit/event/world/SpawnChangeEvent.java b/src/main/java/org/bukkit/event/world/SpawnChangeEvent.java index d3cc1fcc..e99c3c01 100644 --- a/src/main/java/org/bukkit/event/world/SpawnChangeEvent.java +++ b/src/main/java/org/bukkit/event/world/SpawnChangeEvent.java @@ -5,8 +5,8 @@ import org.bukkit.Location; import org.bukkit.event.HandlerList; /** - * An event that is called when a world's spawn changes. The - * world's previous spawn location is included. + * An event that is called when a world's spawn changes. The world's previous + * spawn location is included. */ public class SpawnChangeEvent extends WorldEvent { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/world/StructureGrowEvent.java b/src/main/java/org/bukkit/event/world/StructureGrowEvent.java index 15f4d419..d1c9822a 100644 --- a/src/main/java/org/bukkit/event/world/StructureGrowEvent.java +++ b/src/main/java/org/bukkit/event/world/StructureGrowEvent.java @@ -9,7 +9,8 @@ import org.bukkit.event.Cancellable; import org.bukkit.event.HandlerList; /** - * Event that is called when an organic structure attempts to grow (Sapling -> Tree), (Mushroom -> Huge Mushroom), naturally or using bonemeal. + * Event that is called when an organic structure attempts to grow (Sapling -> + * Tree), (Mushroom -> Huge Mushroom), naturally or using bonemeal. */ public class StructureGrowEvent extends WorldEvent implements Cancellable { private static final HandlerList handlers = new HandlerList(); @@ -39,7 +40,8 @@ public class StructureGrowEvent extends WorldEvent implements Cancellable { } /** - * Gets the species type (birch, normal, pine, red mushroom, brown mushroom) + * Gets the species type (birch, normal, pine, red mushroom, brown + * mushroom) * * @return Structure species */ @@ -59,7 +61,8 @@ public class StructureGrowEvent extends WorldEvent implements Cancellable { /** * Gets the player that created the structure. * - * @return Player that created the structure, null if was not created manually + * @return Player that created the structure, null if was not created + * manually */ public Player getPlayer() { return player; diff --git a/src/main/java/org/bukkit/event/world/WorldSaveEvent.java b/src/main/java/org/bukkit/event/world/WorldSaveEvent.java index ab4e5b59..d46b413c 100644 --- a/src/main/java/org/bukkit/event/world/WorldSaveEvent.java +++ b/src/main/java/org/bukkit/event/world/WorldSaveEvent.java @@ -3,6 +3,9 @@ package org.bukkit.event.world; import org.bukkit.World; import org.bukkit.event.HandlerList; +/** + * Called when a World is saved. + */ public class WorldSaveEvent extends WorldEvent { private static final HandlerList handlers = new HandlerList(); |