Skip to content

Commit

Permalink
Pulling all pending Bukkit-JavaDoc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
SagaciousZed committed Apr 2, 2013
1 parent 10c1edc commit 409595c
Show file tree
Hide file tree
Showing 93 changed files with 539 additions and 505 deletions.
4 changes: 2 additions & 2 deletions src/main/java/org/bukkit/Achievement.java
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ private Achievement(int id) {

/**
* Gets the ID for this achievement.
* <p />
* <p>
* Note that this is offset using {@link #STATISTIC_OFFSET}
*
* @return ID of this achievement
Expand All @@ -60,7 +60,7 @@ public int getId() {

/**
* Gets the achievement associated with the given ID.
* <p />
* <p>
* Note that the ID must already be offset using {@link #STATISTIC_OFFSET}
*
* @param id ID of the achievement to return
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/bukkit/Art.java
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public static Art getById(int id) {

/**
* Get a painting by its unique name
* <p />
* <p>
* This ignores underscores and capitalization
*
* @param name The name
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/bukkit/Bukkit.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public static Server getServer() {

/**
* Attempts to set the {@link Server} singleton.
* <p />
* <p>
* This cannot be done if the Server is already set.
*
* @param server Server instance
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/org/bukkit/EntityEffect.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,28 @@ public enum EntityEffect {

/**
* When a mob dies.
* <p />
* <p>
* <b>This will cause client-glitches!
*/
DEATH(3),

/**
* The smoke when taming a wolf fails.
* <p />
* <p>
* Without client-mods this will be ignored if the entity is not a wolf.
*/
WOLF_SMOKE(6),

/**
* The hearts when taming a wolf succeeds.
* <p />
* <p>
* Without client-mods this will be ignored if the entity is not a wolf.
*/
WOLF_HEARTS(7),

/**
* When a wolf shakes (after being wet).
* <p />
* <p>
* Without client-mods this will be ignored if the entity is not a wolf.
*/
WOLF_SHAKE(8),
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/bukkit/OfflinePlayer.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public interface OfflinePlayer extends ServerOperator, AnimalTamer, Configuratio

/**
* Gets a {@link Player} object that this represents, if there is one
* <p />
* <p>
* If the player is online, this will return that player. Otherwise,
* it will return null.
*
Expand All @@ -60,7 +60,7 @@ public interface OfflinePlayer extends ServerOperator, AnimalTamer, Configuratio

/**
* Gets the first date and time that this player was witnessed on this server.
* <p />
* <p>
* If the player has never played before, this will return 0. Otherwise, it will be
* the amount of milliseconds since midnight, January 1, 1970 UTC.
*
Expand All @@ -70,7 +70,7 @@ public interface OfflinePlayer extends ServerOperator, AnimalTamer, Configuratio

/**
* Gets the last date and time that this player was witnessed on this server.
* <p />
* <p>
* If the player has never played before, this will return 0. Otherwise, it will be
* the amount of milliseconds since midnight, January 1, 1970 UTC.
*
Expand Down
28 changes: 14 additions & 14 deletions src/main/java/org/bukkit/Server.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@
public interface Server extends PluginMessageRecipient {
/**
* Used for all administrative messages, such as an operator using a command.
* <p />
* <p>
* For use in {@link #broadcast(java.lang.String, java.lang.String)}
*/
public static final String BROADCAST_CHANNEL_ADMINISTRATIVE = "bukkit.broadcast.admin";

/**
* Used for all announcement messages, such as informing users that a player has joined.
* <p />
* <p>
* For use in {@link #broadcast(java.lang.String, java.lang.String)}
*/
public static final String BROADCAST_CHANNEL_USERS = "bukkit.broadcast.user";
Expand Down Expand Up @@ -176,7 +176,7 @@ public interface Server extends PluginMessageRecipient {

/**
* Broadcast a message to all players.
* <p />
* <p>
* This is the same as calling {@link #broadcast(java.lang.String, java.lang.String)} to {@link #BROADCAST_CHANNEL_USERS}
*
* @param message the message
Expand All @@ -187,7 +187,7 @@ public interface Server extends PluginMessageRecipient {
/**
* Gets the name of the update folder. The update folder is used to safely update
* plugins at the right moment on a plugin load.
* <p />
* <p>
* The update folder name is relative to the plugins folder.
*
* @return The name of the update folder
Expand All @@ -211,17 +211,17 @@ public interface Server extends PluginMessageRecipient {

/**
* Gets default ticks per animal spawns value
* <p />
* <p>
* <b>Example Usage:</b>
* <ul>
* <li>A value of 1 will mean the server will attempt to spawn monsters every tick.
* <li>A value of 400 will mean the server will attempt to spawn monsters every 400th tick.
* <li>A value below 0 will be reset back to Minecraft's default.
* </ul>
* <p />
* <p>
* <b>Note:</b>
* If set to 0, animal spawning will be disabled. We recommend using spawn-animals to control this instead.
* <p />
* <p>
* Minecraft default: 400.
*
* @return The default ticks per animal spawns value
Expand All @@ -230,17 +230,17 @@ public interface Server extends PluginMessageRecipient {

/**
* Gets the default ticks per monster spawns value
* <p />
* <p>
* <b>Example Usage:</b>
* <ul>
* <li>A value of 1 will mean the server will attempt to spawn monsters every tick.
* <li>A value of 400 will mean the server will attempt to spawn monsters every 400th tick.
* <li>A value below 0 will be reset back to Minecraft's default.
* </ul>
* <p />
* <p>
* <b>Note:</b>
* If set to 0, monsters spawning will be disabled. We recommend using spawn-monsters to control this instead.
* <p />
* <p>
* Minecraft default: 1.
*
* @return The default ticks per monsters spawn value
Expand All @@ -249,7 +249,7 @@ public interface Server extends PluginMessageRecipient {

/**
* Gets a player object by the given username
* <p />
* <p>
* This method may not return objects for offline players
*
* @param name Name to look up
Expand All @@ -268,7 +268,7 @@ public interface Server extends PluginMessageRecipient {
/**
* Attempts to match any players with the given name, and returns a list
* of all possibly matches
* <p />
* <p>
* This list is not sorted in any particular order. If an exact match is found,
* the returned list will only contain a single result.
*
Expand Down Expand Up @@ -307,7 +307,7 @@ public interface Server extends PluginMessageRecipient {

/**
* Creates or loads a world with the given name using the specified options.
* <p />
* <p>
* If the world is already loaded, it will just return the equivalent of
* getWorld(creator.name()).
*
Expand Down Expand Up @@ -510,7 +510,7 @@ public interface Server extends PluginMessageRecipient {

/**
* Gets the player by the given name, regardless if they are offline or online.
* <p />
* <p>
* This will return an object even if the player does not exist. To this method, all players will exist.
*
* @param name Name of the player to retrieve
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/bukkit/Sound.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* An Enum of Sounds the server is able to send to players.
* <p />
* <p>
* WARNING: At any time, sounds may be added/removed from this Enum or even MineCraft itself! There is no guarantee the sounds will play.
* There is no guarantee values will not be removed from this Enum. As such, you should not depend on the ordinal values of this class.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/bukkit/Statistic.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public int getId() {

/**
* Checks if this is a substatistic.
* <p />
* <p>
* A substatistic exists in mass for each block or item, depending on {@link #isBlock()}
*
* @return true if this is a substatistic
Expand Down
Loading

0 comments on commit 409595c

Please sign in to comment.