More JavaDoc improvements.

By: EvilSeph <evilseph@unaligned.org>
This commit is contained in:
Bukkit/Spigot
2011-06-24 02:32:04 -04:00
parent 0630db640b
commit c54128077a
56 changed files with 435 additions and 139 deletions

View File

@@ -4,7 +4,7 @@ import org.bukkit.World;
import org.bukkit.event.Cancellable;
/**
* Stores data for thudner state changing in a world
* Stores data for thunder state changing in a world
*/
public class ThunderChangeEvent extends WeatherEvent implements Cancellable {

View File

@@ -4,7 +4,7 @@ import org.bukkit.World;
import org.bukkit.event.Event;
/**
* Represents an Weather-related event
* Represents a Weather-related event
*/
public class WeatherEvent extends Event {
protected World world;
@@ -15,8 +15,9 @@ public class WeatherEvent extends Event {
}
/**
* Returns the World where this event is occuring
* @return World this event is occuring in
* Returns the World where this event is occurring
*
* @return World this event is occurring in
*/
public final World getWorld() {
return world;

View File

@@ -8,9 +8,24 @@ import org.bukkit.event.Listener;
public class WeatherListener implements Listener {
public WeatherListener() {}
/**
* Called when a weather change occurs
*
* @param event Relevant event details
*/
public void onWeatherChange(WeatherChangeEvent event) {}
/**
* Called when the state of thunder changes
*
* @param event Relevant event details
*/
public void onThunderChange(ThunderChangeEvent event) {}
/**
* Called when lightning strikes
*
* @param event Relevant event details
*/
public void onLightningStrike(LightningStrikeEvent event) {}
}