summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorWesley Wolfe <weswolf@aol.com>2013-02-22 22:49:38 -0600
committerWesley Wolfe <weswolf@aol.com>2013-02-22 22:49:38 -0600
commit90faffc3399be881d6010885c398c845ceb6b848 (patch)
tree6f0c93691d8ce000209808e04365fab1f761aa5e /src
parent76e82dddd95cd020b55ccd0661e7d2bf49b5ed6e (diff)
downloadbukkit-90faffc3399be881d6010885c398c845ceb6b848.tar
bukkit-90faffc3399be881d6010885c398c845ceb6b848.tar.gz
bukkit-90faffc3399be881d6010885c398c845ceb6b848.tar.lz
bukkit-90faffc3399be881d6010885c398c845ceb6b848.tar.xz
bukkit-90faffc3399be881d6010885c398c845ceb6b848.zip
Pulling all pending Bukkit-JavaDoc changes
Diffstat (limited to 'src')
-rw-r--r--src/main/java/org/bukkit/Server.java2
-rw-r--r--src/main/java/org/bukkit/World.java9
-rw-r--r--src/main/java/org/bukkit/block/Skull.java2
-rw-r--r--src/main/java/org/bukkit/configuration/ConfigurationSection.java4
-rw-r--r--src/main/java/org/bukkit/conversations/FixedSetPrompt.java4
-rw-r--r--src/main/java/org/bukkit/event/Event.java2
-rw-r--r--src/main/java/org/bukkit/scheduler/BukkitRunnable.java7
-rw-r--r--src/main/javadoc/org/bukkit/block/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/command/defaults/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/command/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/configuration/file/package-info.java8
-rw-r--r--src/main/javadoc/org/bukkit/configuration/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/configuration/serialization/package-info.java8
-rw-r--r--src/main/javadoc/org/bukkit/conversations/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/enchantments/package-info.java8
-rw-r--r--src/main/javadoc/org/bukkit/entity/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/event/block/package-info.java8
-rw-r--r--src/main/javadoc/org/bukkit/event/enchantment/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/event/entity/package-info.java8
-rw-r--r--src/main/javadoc/org/bukkit/event/hanging/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/event/inventory/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/event/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/event/painting/package-info.java8
-rw-r--r--src/main/javadoc/org/bukkit/event/player/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/event/server/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/event/vehicle/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/event/weather/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/event/world/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/generator/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/help/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/inventory/meta/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/inventory/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/map/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/material/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/metadata/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/permissions/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/plugin/java/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/plugin/messaging/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/plugin/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/potion/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/scheduler/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/util/noise/package-info.java6
-rw-r--r--src/main/javadoc/org/bukkit/util/package-info.java7
-rw-r--r--src/main/javadoc/org/bukkit/util/permissions/package-info.java7
-rw-r--r--src/main/javadoc/overview.html17
46 files changed, 292 insertions, 14 deletions
diff --git a/src/main/java/org/bukkit/Server.java b/src/main/java/org/bukkit/Server.java
index 49c3f5c3..683938a3 100644
--- a/src/main/java/org/bukkit/Server.java
+++ b/src/main/java/org/bukkit/Server.java
@@ -652,7 +652,7 @@ public interface Server extends PluginMessageRecipient {
/**
* Gets user-specified limit for number of ambient mobs that can spawn in a chunk
- * @returns The ambient spawn limit
+ * @return The ambient spawn limit
*/
int getAmbientSpawnLimit();
diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java
index 4b9e39e2..266a59ad 100644
--- a/src/main/java/org/bukkit/World.java
+++ b/src/main/java/org/bukkit/World.java
@@ -671,10 +671,11 @@ public interface World extends PluginMessageRecipient, Metadatable {
* Spawn a {@link FallingBlock} entity at the given {@link Location} of the specified blockId (converted to {@link Material})
*
* @param location The {@link Location} to spawn the FallingBlock
- * @param blockId see {@see #spawnFallingBlock(org.bukkit.Location, org.bukkit.Material, byte)} material
+ * @param blockId The id of the intended material
* @param blockData The block data
* @return The spawned FallingBlock instance
- * @throws IllegalArgumentException see {@see #spawnFallingBlock(org.bukkit.Location, org.bukkit.Material, byte)}
+ * @throws IllegalArgumentException if location is null, or blockId is invalid
+ * @see #spawnFallingBlock(org.bukkit.Location, org.bukkit.Material, byte)
*/
public FallingBlock spawnFallingBlock(Location location, int blockId, byte blockData) throws IllegalArgumentException;
@@ -999,7 +1000,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
/**
* Gets the limit for number of ambient mobs that can spawn in a chunk in this world
- * @returns The ambient spawn limit
+ * @return The ambient spawn limit
*/
int getAmbientSpawnLimit();
@@ -1021,7 +1022,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
* @param volume The volume of the sound
* @param pitch The pitch of the sound
*/
- void playSound(Location loc, Sound sound, float volume, float pitch);
+ void playSound(Location location, Sound sound, float volume, float pitch);
/**
* Get existing rules
diff --git a/src/main/java/org/bukkit/block/Skull.java b/src/main/java/org/bukkit/block/Skull.java
index e5ee6b6e..44c4aa64 100644
--- a/src/main/java/org/bukkit/block/Skull.java
+++ b/src/main/java/org/bukkit/block/Skull.java
@@ -24,7 +24,7 @@ public interface Skull extends BlockState {
/**
* Sets the owner of the skull
*
- * @param owner the new owner of the skull
+ * @param name the new owner of the skull
* @return true if the owner was successfully set
*/
public boolean setOwner(String name);
diff --git a/src/main/java/org/bukkit/configuration/ConfigurationSection.java b/src/main/java/org/bukkit/configuration/ConfigurationSection.java
index 9a11fd34..6a899b7a 100644
--- a/src/main/java/org/bukkit/configuration/ConfigurationSection.java
+++ b/src/main/java/org/bukkit/configuration/ConfigurationSection.java
@@ -297,7 +297,7 @@ public interface ConfigurationSection {
* <p />
* If the double does not exist but a default value has been specified, this
* will return the default value. If the double does not exist and no default
- * value was specified, this will return null.
+ * value was specified, this will return 0.
*
* @param path Path of the double to get.
* @return Requested double.
@@ -334,7 +334,7 @@ public interface ConfigurationSection {
* <p />
* If the long does not exist but a default value has been specified, this
* will return the default value. If the long does not exist and no default
- * value was specified, this will return null.
+ * value was specified, this will return 0.
*
* @param path Path of the long to get.
* @return Requested long.
diff --git a/src/main/java/org/bukkit/conversations/FixedSetPrompt.java b/src/main/java/org/bukkit/conversations/FixedSetPrompt.java
index 189fda9e..907df0cc 100644
--- a/src/main/java/org/bukkit/conversations/FixedSetPrompt.java
+++ b/src/main/java/org/bukkit/conversations/FixedSetPrompt.java
@@ -31,8 +31,8 @@ public abstract class FixedSetPrompt extends ValidatingPrompt {
/**
* Utility function to create a formatted string containing all the options declared in the constructor.
- * The result is formatted like "[bar, cheese, panda]"
- * @return
+ *
+ * @return the options formatted like "[bar, cheese, panda]" if bar, cheese, and panda were the options used
*/
protected String formatFixedSet() {
return "[" + StringUtils.join(fixedSet, ", ") + "]";
diff --git a/src/main/java/org/bukkit/event/Event.java b/src/main/java/org/bukkit/event/Event.java
index 273e5b26..d754d714 100644
--- a/src/main/java/org/bukkit/event/Event.java
+++ b/src/main/java/org/bukkit/event/Event.java
@@ -17,6 +17,7 @@ public abstract class Event {
/**
* This constructor is used to explicitly declare an event as synchronous or asynchronous.
+ *
* @param isAsync true indicates the event will fire asynchronously. false by default
*/
public Event(boolean isAsync) {
@@ -47,6 +48,7 @@ public abstract class Event {
* <li>Some implementations may selectively declare a specific event use as asynchronous.
* This behavior should be clearly defined.</li>
* <li>Asynchronous calls are not calculated in the plugin timing system.</li>
+ *
* @return false by default, true if the event fires asynchronously
*/
public final boolean isAsynchronous() {
diff --git a/src/main/java/org/bukkit/scheduler/BukkitRunnable.java b/src/main/java/org/bukkit/scheduler/BukkitRunnable.java
index f51f5236..218273fa 100644
--- a/src/main/java/org/bukkit/scheduler/BukkitRunnable.java
+++ b/src/main/java/org/bukkit/scheduler/BukkitRunnable.java
@@ -42,7 +42,7 @@ public abstract class BukkitRunnable implements Runnable {
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalStateException if this was already scheduled
- * @see BukkitScheduler#runTaskAsynchronously(Plugin, Runnable, long, long)
+ * @see BukkitScheduler#runTaskAsynchronously(Plugin, Runnable)
*/
public synchronized BukkitTask runTaskAsynchronously(Plugin plugin) throws IllegalArgumentException, IllegalStateException {
checkState();
@@ -53,12 +53,11 @@ public abstract class BukkitRunnable implements Runnable {
* Schedules this to run after the specified number of server ticks.
*
* @param plugin the reference to the plugin scheduling task
- * @param task the task to be run
* @param delay the ticks to wait before running the task
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalStateException if this was already scheduled
- * @see BukkitScheduler#runTaskLater(Plugin, Runnable, long, long)
+ * @see BukkitScheduler#runTaskLater(Plugin, Runnable, long)
*/
public synchronized BukkitTask runTaskLater(Plugin plugin, long delay) throws IllegalArgumentException, IllegalStateException {
checkState();
@@ -76,7 +75,7 @@ public abstract class BukkitRunnable implements Runnable {
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalStateException if this was already scheduled
- * @see BukkitScheduler#runTaskLaterAsynchronously(Plugin, Runnable, long, long)
+ * @see BukkitScheduler#runTaskLaterAsynchronously(Plugin, Runnable, long)
*/
public synchronized BukkitTask runTaskLaterAsynchronously(Plugin plugin, long delay) throws IllegalArgumentException, IllegalStateException {
checkState();
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;
+
diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
new file mode 100644
index 00000000..e96bf35e
--- /dev/null
+++ b/src/main/javadoc/overview.html
@@ -0,0 +1,17 @@
+<body>
+ <p>Bukkit, the plugin development framework.</p>
+
+ <p>
+ The documentation is for developing plugins and is split into the
+ respective packages for each subject matter. This documentation does not
+ cover running a server, contributing code back to the project, or setting
+ up a workspace. Working knowledge of the Java language is a prerequisite
+ for developing plugins.
+ </p><p>
+ For basic plugin development, see the {@link org.bukkit.plugin plugin
+ package}. It covers the basic requirements of a plugin jar.
+ </p><p>
+ For handling events and triggered code, see the {@link org.bukkit.event
+ event package}.
+ </p>
+</body>