Pulling all pending Bukkit-JavaDoc changes

38 files changed, 259 insertions, 0 deletions

diff --git a/src/main/javadoc/org/bukkit/block/package-info.java b/src/main/javadoc/org/bukkit/block/package-info.java
new file mode 100644
index 00000000..fb7719b7
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/block/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Classes used to manipulate the voxels in a {@link org.bukkit.World world},
+ * including special states.
+ * <p>
+ */
+package org.bukkit.block;
+
diff --git a/src/main/javadoc/org/bukkit/command/defaults/package-info.java b/src/main/javadoc/org/bukkit/command/defaults/package-info.java
new file mode 100644
index 00000000..f2967308
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/command/defaults/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Commands for emulating the Minecraft commands and other necessary ones for
+ * use by a Bukkit implementation.
+ * <p>
+ */
+package org.bukkit.command.defaults;
+
diff --git a/src/main/javadoc/org/bukkit/command/package-info.java b/src/main/javadoc/org/bukkit/command/package-info.java
new file mode 100644
index 00000000..f06407a5
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/command/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes relating to handling specialized non-chat player input.
+ * <p>
+ */
+package org.bukkit.command;
+
diff --git a/src/main/javadoc/org/bukkit/configuration/file/package-info.java b/src/main/javadoc/org/bukkit/configuration/file/package-info.java
new file mode 100644
index 00000000..9b1161bd
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/configuration/file/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * Classes dedicated facilitating {@link 
+ * org.bukkit.configuration.Configuration configurations} to be read and
+ * stored on the filesystem.
+ * <p>
+ */
+package org.bukkit.configuration.file;
+
diff --git a/src/main/javadoc/org/bukkit/configuration/package-info.java b/src/main/javadoc/org/bukkit/configuration/package-info.java
new file mode 100644
index 00000000..fc439dbb
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/configuration/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes dedicated to handling a plugin's runtime configuration.
+ * <p>
+ */
+package org.bukkit.configuration;
+
diff --git a/src/main/javadoc/org/bukkit/configuration/serialization/package-info.java b/src/main/javadoc/org/bukkit/configuration/serialization/package-info.java
new file mode 100644
index 00000000..b33306f2
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/configuration/serialization/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * Classes dedicated to being able to perform serialization specialized for
+ * the Bukkit {@link org.bukkit.configuration.Configuration configuration}
+ * implementation.
+ * <p>
+ */
+package org.bukkit.configuration.serialization;
+
diff --git a/src/main/javadoc/org/bukkit/conversations/package-info.java b/src/main/javadoc/org/bukkit/conversations/package-info.java
new file mode 100644
index 00000000..2259e925
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/conversations/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes dedicated to facilitate direct player-to-plugin communication.
+ * <p>
+ */
+package org.bukkit.conversations;
+
diff --git a/src/main/javadoc/org/bukkit/enchantments/package-info.java b/src/main/javadoc/org/bukkit/enchantments/package-info.java
new file mode 100644
index 00000000..a686c828
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/enchantments/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * Classes relating to the specialized enhancements to {@link
+ * org.bukkit.inventory.ItemStack item stacks}, as part of the {@link
+ * org.bukkit.inventory.meta.ItemMeta meta data}.
+ * <p>
+ */
+package org.bukkit.enchantments;
+
diff --git a/src/main/javadoc/org/bukkit/entity/package-info.java b/src/main/javadoc/org/bukkit/entity/package-info.java
new file mode 100644
index 00000000..581209ba
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/entity/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Interfaces for non-voxel objects that can exist in a {@link
+ * org.bukkit.World world}, including all players, monsters, projectiles, etc.
+ * <p>
+ */
+package org.bukkit.entity;
+
diff --git a/src/main/javadoc/org/bukkit/event/block/package-info.java b/src/main/javadoc/org/bukkit/event/block/package-info.java
new file mode 100644
index 00000000..dd53485b
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/block/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to when a {@link
+ * org.bukkit.block.Block block} is changed or interacts with the {@link
+ * org.bukkit.World world}.
+ * <p>
+ */
+package org.bukkit.event.block;
+
diff --git a/src/main/javadoc/org/bukkit/event/enchantment/package-info.java b/src/main/javadoc/org/bukkit/event/enchantment/package-info.java
new file mode 100644
index 00000000..7be6f83b
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/enchantment/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * {@link org.bukkit.event.Event Events} triggered from an {@link
+ * org.bukkit.inventory.EnchantingInventory enchantment table}.
+ * <p>
+ */
+package org.bukkit.event.enchantment;
+
diff --git a/src/main/javadoc/org/bukkit/event/entity/package-info.java b/src/main/javadoc/org/bukkit/event/entity/package-info.java
new file mode 100644
index 00000000..36a1a096
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/entity/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to {@link
+ * org.bukkit.entity.Entity entities}, excluding some directly referencing
+ * some more specific entity types.
+ * <p>
+ */
+package org.bukkit.event.entity;
+
diff --git a/src/main/javadoc/org/bukkit/event/hanging/package-info.java b/src/main/javadoc/org/bukkit/event/hanging/package-info.java
new file mode 100644
index 00000000..63e9e7e6
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/hanging/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to {@link
+ * org.bukkit.entity.Hanging entities that hang}.
+ * <p>
+ */
+package org.bukkit.event.hanging;
+
diff --git a/src/main/javadoc/org/bukkit/event/inventory/package-info.java b/src/main/javadoc/org/bukkit/event/inventory/package-info.java
new file mode 100644
index 00000000..7cb5a636
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/inventory/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to {@link
+ * org.bukkit.inventory.Inventory inventory} manipulation.
+ * <p>
+ */
+package org.bukkit.event.inventory;
+
diff --git a/src/main/javadoc/org/bukkit/event/package-info.java b/src/main/javadoc/org/bukkit/event/package-info.java
new file mode 100644
index 00000000..ab3011a2
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes dedicated to handling triggered code executions.
+ * <p>
+ */
+package org.bukkit.event;
+
diff --git a/src/main/javadoc/org/bukkit/event/painting/package-info.java b/src/main/javadoc/org/bukkit/event/painting/package-info.java
new file mode 100644
index 00000000..39a8bb7d
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/painting/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to {@link
+ * org.bukkit.entity.Painting paintings}, but deprecated for more general
+ * {@link org.bukkit.event.hanging hanging} events.
+ * <p>
+ */
+package org.bukkit.event.painting;
+
diff --git a/src/main/javadoc/org/bukkit/event/player/package-info.java b/src/main/javadoc/org/bukkit/event/player/package-info.java
new file mode 100644
index 00000000..c5a49541
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/player/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to {@link
+ * org.bukkit.entity.Player players}.
+ * <p>
+ */
+package org.bukkit.event.player;
+
diff --git a/src/main/javadoc/org/bukkit/event/server/package-info.java b/src/main/javadoc/org/bukkit/event/server/package-info.java
new file mode 100644
index 00000000..a2e16998
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/server/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to programmatic state
+ * changes on the server.
+ * <p>
+ */
+package org.bukkit.event.server;
+
diff --git a/src/main/javadoc/org/bukkit/event/vehicle/package-info.java b/src/main/javadoc/org/bukkit/event/vehicle/package-info.java
new file mode 100644
index 00000000..07c470a2
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/vehicle/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to {@link
+ * org.bukkit.entity.Vehicle vehicular entities}.
+ * <p>
+ */
+package org.bukkit.event.vehicle;
+
diff --git a/src/main/javadoc/org/bukkit/event/weather/package-info.java b/src/main/javadoc/org/bukkit/event/weather/package-info.java
new file mode 100644
index 00000000..f2e3f49e
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/weather/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * {@link org.bukkit.event.Event Events} relating to weather.
+ * <p>
+ */
+package org.bukkit.event.weather;
+
diff --git a/src/main/javadoc/org/bukkit/event/world/package-info.java b/src/main/javadoc/org/bukkit/event/world/package-info.java
new file mode 100644
index 00000000..3b075f6d
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/event/world/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * {@link org.bukkit.event.Event Events} triggered by various {@link
+ * org.bukkit.World world} states or changes.
+ * <p>
+ */
+package org.bukkit.event.world;
+
diff --git a/src/main/javadoc/org/bukkit/generator/package-info.java b/src/main/javadoc/org/bukkit/generator/package-info.java
new file mode 100644
index 00000000..54d1c294
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/generator/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Classes to facilitate {@link org.bukkit.World world} generation
+ * implementation.
+ * <p>
+ */
+package org.bukkit.generator;
+
diff --git a/src/main/javadoc/org/bukkit/help/package-info.java b/src/main/javadoc/org/bukkit/help/package-info.java
new file mode 100644
index 00000000..691dfcd3
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/help/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes used to manipulate the default command and topic assistance system.
+ * <p>
+ */
+package org.bukkit.help;
+
diff --git a/src/main/javadoc/org/bukkit/inventory/meta/package-info.java b/src/main/javadoc/org/bukkit/inventory/meta/package-info.java
new file mode 100644
index 00000000..f39d93a4
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/inventory/meta/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * The interfaces used when manipulating extra data can can be stored inside
+ * {@link org.bukkit.inventory.ItemStack item stacks}.
+ * <p>
+ */
+package org.bukkit.inventory.meta;
+
diff --git a/src/main/javadoc/org/bukkit/inventory/package-info.java b/src/main/javadoc/org/bukkit/inventory/package-info.java
new file mode 100644
index 00000000..79e26ca2
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/inventory/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes involved in manipulating player inventories and item interactions.
+ * <p>
+ */
+package org.bukkit.inventory;
+
diff --git a/src/main/javadoc/org/bukkit/map/package-info.java b/src/main/javadoc/org/bukkit/map/package-info.java
new file mode 100644
index 00000000..9e08d6e5
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/map/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Classes to facilitate plugin handling of {@link org.bukkit.Material#MAP
+ * map} displays.
+ * <p>
+ */
+package org.bukkit.map;
+
diff --git a/src/main/javadoc/org/bukkit/material/package-info.java b/src/main/javadoc/org/bukkit/material/package-info.java
new file mode 100644
index 00000000..d2fa49fa
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/material/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes that represents various voxel types and states.
+ * <p>
+ */
+package org.bukkit.material;
+
diff --git a/src/main/javadoc/org/bukkit/metadata/package-info.java b/src/main/javadoc/org/bukkit/metadata/package-info.java
new file mode 100644
index 00000000..44227e6a
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/metadata/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Classes dedicated to providing a layer of plugin specified data on various
+ * Minecraft concepts.
+ * <p>
+ */
+package org.bukkit.metadata;
+
diff --git a/src/main/javadoc/org/bukkit/package-info.java b/src/main/javadoc/org/bukkit/package-info.java
new file mode 100644
index 00000000..f85c88d1
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * More generalized classes in the API.
+ * <p>
+ */
+package org.bukkit;
+
diff --git a/src/main/javadoc/org/bukkit/permissions/package-info.java b/src/main/javadoc/org/bukkit/permissions/package-info.java
new file mode 100644
index 00000000..3a5befe2
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/permissions/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes dedicated to providing binary state properties to players.
+ * <p>
+ */
+package org.bukkit.permissions;
+
diff --git a/src/main/javadoc/org/bukkit/plugin/java/package-info.java b/src/main/javadoc/org/bukkit/plugin/java/package-info.java
new file mode 100644
index 00000000..8d6f2a5b
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/plugin/java/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Classes for handling {@link org.bukkit.plugin.Plugin plugins} written in
+ * java.
+ * <p>
+ */
+package org.bukkit.plugin.java;
+
diff --git a/src/main/javadoc/org/bukkit/plugin/messaging/package-info.java b/src/main/javadoc/org/bukkit/plugin/messaging/package-info.java
new file mode 100644
index 00000000..c94ac66c
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/plugin/messaging/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes dedicated to specialized plugin to client protocols.
+ * <p>
+ */
+package org.bukkit.plugin.messaging;
+
diff --git a/src/main/javadoc/org/bukkit/plugin/package-info.java b/src/main/javadoc/org/bukkit/plugin/package-info.java
new file mode 100644
index 00000000..087a0a4a
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/plugin/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes specifically relating to loading software modules at runtime.
+ * <p>
+ */
+package org.bukkit.plugin;
+
diff --git a/src/main/javadoc/org/bukkit/potion/package-info.java b/src/main/javadoc/org/bukkit/potion/package-info.java
new file mode 100644
index 00000000..9b13a773
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/potion/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Classes to represent various {@link org.bukkit.Material#POTION potion}
+ * properties and manipulation.
+ * <p>
+ */
+package org.bukkit.potion;
+
diff --git a/src/main/javadoc/org/bukkit/scheduler/package-info.java b/src/main/javadoc/org/bukkit/scheduler/package-info.java
new file mode 100644
index 00000000..87059ea1
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/scheduler/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Classes dedicated to letting {@link org.bukkit.plugin.Plugin plugins} run
+ * code at specific time intervals, including thread safety.
+ * <p>
+ */
+package org.bukkit.scheduler;
+
diff --git a/src/main/javadoc/org/bukkit/util/noise/package-info.java b/src/main/javadoc/org/bukkit/util/noise/package-info.java
new file mode 100644
index 00000000..f77e35d0
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/util/noise/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes dedicated to facilitating deterministic noise.
+ * <p>
+ */
+package org.bukkit.util.noise;
+
diff --git a/src/main/javadoc/org/bukkit/util/package-info.java b/src/main/javadoc/org/bukkit/util/package-info.java
new file mode 100644
index 00000000..a9c4c9d8
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/util/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Multi and single purpose classes to facilitate various programmatic
+ * concepts.
+ * <p>
+ */
+package org.bukkit.util;
+
diff --git a/src/main/javadoc/org/bukkit/util/permissions/package-info.java b/src/main/javadoc/org/bukkit/util/permissions/package-info.java
new file mode 100644
index 00000000..9a40b299
--- /dev/null
+++ b/src/main/javadoc/org/bukkit/util/permissions/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Static methods for miscellaneous {@link org.bukkit.permissions.Permission
+ * permission} functionality.
+ * <p>
+ */
+package org.bukkit.util.permissions;
+