Improve javadoc in 26 files.

Addresses:
BUKKIT-1643, BUKKIT-1868, BUKKIT-1846, BUKKIT-2632, BUKKIT-3196,
BUKKIT-3187, BUKKIT-3198, BUKKIT-3200, BUKKIT-3201 and BUKKIT-3417.

By: feildmaster <admin@feildmaster.com>
This commit is contained in:
Bukkit/Spigot
2013-01-22 15:09:24 -06:00
parent c5392313d3
commit 8065c9095a
26 changed files with 253 additions and 144 deletions

View File

@@ -71,7 +71,7 @@ public class BlockIgniteEvent extends BlockEvent implements Cancellable {
*/
LIGHTNING,
/**
* Block ignition caused by a player using a fireball.
* Block ignition caused by an entity using a fireball.
*/
FIREBALL,
}

View File

@@ -84,11 +84,11 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
public enum State {
/**
* When a player is fishing
* When a player is fishing, ie casting the line out.
*/
FISHING,
/**
* When a player has successfully caught a fish
* When a player has successfully caught a fish and is reeling it in.
*/
CAUGHT_FISH,
/**
@@ -96,7 +96,7 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
*/
CAUGHT_ENTITY,
/**
* When a bobber is stuck in the grund
* When a bobber is stuck in the ground
*/
IN_GROUND,
/**

View File

@@ -60,7 +60,7 @@ public class ServerListPingEvent extends ServerEvent {
/**
* Get the maximum number of players sent.
*
* @return the the maximum number of player
* @return the maximum number of players
*/
public int getMaxPlayers() {
return maxPlayers;