Skip to content

miscellaneous javadoc fixes #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/OfflinePlayer.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import org.bukkit.permissions.ServerOperator;

public interface OfflinePlayer extends ServerOperator, AnimalTamer, ConfigurationSerializable {

/**
* Checks if this player is currently online
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/Rotation.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* It represents how something is viewed, as opposed to cardinal directions.
*/
public enum Rotation {

/**
* No rotation
*/
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/Server.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
* Represents a server implementation
*/
public interface Server extends PluginMessageRecipient {

/**
* Used for all administrative messages, such as an operator using a command.
* <p>
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/TreeType.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Tree and organic structure types.
*/
public enum TreeType {

/**
* Regular tree, no branches
*/
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/org/bukkit/Warning.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@
@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Warning {

/**
* This represents the states that server verbose for warnings may be.
*/
public enum WarningState {

/**
* Indicates all warnings should be printed for deprecated items.
*/
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/command/BlockCommandSender.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import org.bukkit.block.Block;

public interface BlockCommandSender extends CommandSender {

/**
* Returns the block this command sender belongs to
*
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/bukkit/command/MultipleCommandAlias.java
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ public MultipleCommandAlias(String name, Command[] commands) {
this.commands = commands;
}

/**
* Gets the commands associated with the multi-command alias.
*
* @return commands associated with alias
*/
public Command[] getCommands() {
return commands;
}
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/org/bukkit/command/PluginCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ public CommandExecutor getExecutor() {

/**
* Sets the {@link TabCompleter} to run when tab-completing this command.
* <p>
* If no TabCompleter is specified, and the command's executor implements
* TabCompleter, then the executor will be used for tab completion.
*
Expand Down Expand Up @@ -112,6 +113,7 @@ public Plugin getPlugin() {
* {@link Command#tabComplete(CommandSender, String, String[])}.<br>
* <br>
* This method does not consider permissions.
*
* @throws CommandException if the completer or executor throw an exception during the process of tab-completing.
* @throws IllegalArgumentException if sender, alias, or args is null
*/
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/command/TabCommandExecutor.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

/**
* Represents a class which can handle command tab completion and commands
*
* @deprecated Remains for plugins that would have implemented it even without functionality
* @see TabExecutor
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/
@SuppressWarnings("serial")
public class InvalidConfigurationException extends Exception {

/**
* Creates a new instance of InvalidConfigurationException without a message or cause.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@
* </ul>
* In addition to implementing this interface, you must register the class with
* {@link ConfigurationSerialization#registerClass(Class)}.
*
* @see DelegateDeserialization
* @see SerializableAs
*/
public interface ConfigurationSerializable {

/**
* Creates a Map representation of this class.
* <p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* <p>
* Using this annotation on any other class than a {@link ConfigurationSerializable} will
* have no effect.
*
* @see ConfigurationSerialization#registerClass(Class, String)
*/
@Retention(RetentionPolicy.RUNTIME)
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/AnimalTamer.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.bukkit.entity;

public interface AnimalTamer {

/**
* This is the name of the specified AnimalTamer.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/ComplexEntityPart.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Represents a single part of a {@link ComplexLivingEntity}
*/
public interface ComplexEntityPart extends Entity {

/**
* Gets the parent {@link ComplexLivingEntity} of this part.
*
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/bukkit/entity/EntityType.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@
import org.bukkit.World;

public enum EntityType {

// These strings MUST match the strings in nms.EntityTypes and are case sensitive.
/**
* An item resting on the ground.
*
* <p>
* Spawn with {@link World#dropItem(Location, ItemStack)}
* or {@link World#dropItemNaturally(Location, ItemStack)}
*/
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/ExperienceOrb.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Represents an Experience Orb.
*/
public interface ExperienceOrb extends Entity {

/**
* Gets how much experience is contained within this orb
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/Explosive.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* A representation of an explosive entity
*/
public interface Explosive extends Entity {

/**
* Set the radius affected by this explosive's explosion
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/FallingBlock.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* Represents a falling block
*/
public interface FallingBlock extends Entity {

/**
* Get the Material of the falling block
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/Fireball.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* Represents a Fireball.
*/
public interface Fireball extends Projectile, Explosive {

/**
* Fireballs fly straight and do not take setVelocity(...) well.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/Firework.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import org.bukkit.inventory.meta.FireworkMeta;

public interface Firework extends Entity {

/**
* Get a copy of the fireworks meta
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/Ocelot.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* A wild tameable cat
*/
public interface Ocelot extends Animals, Tameable {

/**
* Gets the current type of this cat.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/Painting.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* Represents a Painting.
*/
public interface Painting extends Hanging {

/**
* Get the art on this painting
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/PigZombie.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Represents a Pig Zombie.
*/
public interface PigZombie extends Zombie {

/**
* Get the pig zombie's current anger level.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/Skeleton.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Represents a Skeleton.
*/
public interface Skeleton extends Monster {

/**
* Gets the current type of this skeleton.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/TNTPrimed.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Represents a Primed TNT.
*/
public interface TNTPrimed extends Explosive {

/**
* Set the number of ticks until the TNT blows up after being primed.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/Villager.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Represents a villager NPC
*/
public interface Villager extends Ageable, NPC {

/**
* Gets the current profession of this villager.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/entity/Zombie.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Represents a Zombie.
*/
public interface Zombie extends Monster {

/**
* Gets whether the zombie is a baby
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/event/Cancellable.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.bukkit.event;

public interface Cancellable {

/**
* Gets the cancellation state of this event. A cancelled event will not
* be executed in the server, but will still pass to other plugins
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/event/EventPriority.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Represents an event's priority in execution
*/
public enum EventPriority {

/**
* Event call is of very low importance and should be ran first, to allow
* other plugins to further customise the outcome
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/event/HandlerList.java
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* A list of event handlers, stored per-event. Based on lahwran's fevents.
*/
public class HandlerList {

/**
* Handler array. This field being an array is the key to this system's speed.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
import org.bukkit.block.Block;
import org.bukkit.entity.Entity;

/**
* Called when a block causes an entity to combust.
*/
public class EntityCombustByBlockEvent extends EntityCombustEvent {
private final Block combuster;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

import org.bukkit.entity.Entity;

/**
* Called when an entity causes another entity to combust.
*/
public class EntityCombustByEntityEvent extends EntityCombustEvent {
private final Entity combuster;

Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/bukkit/event/entity/ItemDespawnEvent.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;

/**
* Called when an item de-spawns from the world.
*/
public class ItemDespawnEvent extends EntityEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();
private boolean canceled;
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/event/inventory/ClickType.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* What the client did to trigger this action (not the result).
*/
public enum ClickType {

/**
* The left (or primary) mouse button.
*/
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/bukkit/event/inventory/CraftItemEvent.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.Recipe;

/**
* Called when the recipe of an Item is completed inside a crafting matrix.
*/
public class CraftItemEvent extends InventoryClickEvent {
private Recipe recipe;

Expand Down
2 changes: 2 additions & 0 deletions src/main/java/org/bukkit/event/inventory/InventoryAction.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
* An estimation of what the result will be.
*/
public enum InventoryAction {

/**
* Nothing will happen from the click.
* <p>
* There may be cases where nothing will happen and this is value is
* not provided, but it is guaranteed that this value is accurate
* when given.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.bukkit.event.inventory;

public enum InventoryType {

/**
* A chest inventory, with 0, 9, 18, 27, 36, 45, or 54 slots of type CONTAINER.
*/
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/bukkit/event/player/PlayerBucketEvent.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
import org.bukkit.event.Cancellable;
import org.bukkit.inventory.ItemStack;

/**
* Called when a player interacts with a Bucket
*/
public abstract class PlayerBucketEvent extends PlayerEvent implements Cancellable {
private ItemStack itemStack;
private boolean cancelled = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
import org.bukkit.entity.Vehicle;
import org.bukkit.event.HandlerList;

/**
* Called when a vehicle updates
*/
public class VehicleUpdateEvent extends VehicleEvent {
private static final HandlerList handlers = new HandlerList();

Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/generator/BlockPopulator.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* For example, generating glowstone inside the nether or generating dungeons full of treasure
*/
public abstract class BlockPopulator {

/**
* Populates an area of blocks at or around the given chunk.
* <p>
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/generator/ChunkGenerator.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* For example, the nether chunk generator should shape netherrack and soulsand
*/
public abstract class ChunkGenerator {

/**
* Interface to biome data for chunk to be generated: initialized with default values for world type and seed.
* <p>
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/inventory/BeaconInventory.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package org.bukkit.inventory;

public interface BeaconInventory extends Inventory {

/**
* Set the item powering the beacon.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/inventory/BrewerInventory.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import org.bukkit.block.BrewingStand;

public interface BrewerInventory extends Inventory {

/**
* Get the current ingredient for brewing.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/bukkit/inventory/CraftingInventory.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Interface to the crafting inventories
*/
public interface CraftingInventory extends Inventory {

/**
* Check what item is in the result slot of this crafting inventory.
*
Expand Down
Loading