Pulling all pending Bukkit-JavaDoc changes

7 files changed, 16 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();