Clean up the javadoc to pass java 8's doclint

By: Thinkofdeath <thinkofdeath@spigotmc.org>
This commit is contained in:
Bukkit/Spigot
2014-11-30 21:09:01 +00:00
parent 8344aacc6e
commit b2d54f59bb
156 changed files with 1155 additions and 501 deletions

View File

@@ -21,6 +21,10 @@ public interface BukkitScheduler {
/**
* @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)}
* @param plugin Plugin that owns the task
* @param task Task to be executed
* @param delay Delay in server ticks before executing task
* @return Task id number (-1 if scheduling failed)
*/
@Deprecated
public int scheduleSyncDelayedTask(Plugin plugin, BukkitRunnable task, long delay);
@@ -38,6 +42,9 @@ public interface BukkitScheduler {
/**
* @deprecated Use {@link BukkitRunnable#runTask(Plugin)}
* @param plugin Plugin that owns the task
* @param task Task to be executed
* @return Task id number (-1 if scheduling failed)
*/
@Deprecated
public int scheduleSyncDelayedTask(Plugin plugin, BukkitRunnable task);
@@ -56,7 +63,12 @@ public interface BukkitScheduler {
public int scheduleSyncRepeatingTask(Plugin plugin, Runnable task, long delay, long period);
/**
* @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}
* @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)} *
* @param plugin Plugin that owns the task
* @param task Task to be executed
* @param delay Delay in server ticks before executing first repeat
* @param period Period in server ticks of the task
* @return Task id number (-1 if scheduling failed)
*/
@Deprecated
public int scheduleSyncRepeatingTask(Plugin plugin, BukkitRunnable task, long delay, long period);
@@ -208,6 +220,12 @@ public interface BukkitScheduler {
/**
* @deprecated Use {@link BukkitRunnable#runTask(Plugin)}
*
* @param plugin the reference to the plugin scheduling task
* @param task the task to be run
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null
*/
@Deprecated
public BukkitTask runTask(Plugin plugin, BukkitRunnable task) throws IllegalArgumentException;
@@ -228,6 +246,11 @@ public interface BukkitScheduler {
/**
* @deprecated Use {@link BukkitRunnable#runTaskAsynchronously(Plugin)}
* @param plugin the reference to the plugin scheduling task
* @param task the task to be run
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null
*/
@Deprecated
public BukkitTask runTaskAsynchronously(Plugin plugin, BukkitRunnable task) throws IllegalArgumentException;
@@ -247,6 +270,12 @@ public interface BukkitScheduler {
/**
* @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)}
* @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 IllegalArgumentException if task is null
*/
@Deprecated
public BukkitTask runTaskLater(Plugin plugin, BukkitRunnable task, long delay) throws IllegalArgumentException;
@@ -269,6 +298,12 @@ public interface BukkitScheduler {
/**
* @deprecated Use {@link BukkitRunnable#runTaskLaterAsynchronously(Plugin, long)}
* @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 IllegalArgumentException if task is null
*/
@Deprecated
public BukkitTask runTaskLaterAsynchronously(Plugin plugin, BukkitRunnable task, long delay) throws IllegalArgumentException;
@@ -289,6 +324,13 @@ public interface BukkitScheduler {
/**
* @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}
* @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
* @param period the ticks to wait between runs
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null
*/
@Deprecated
public BukkitTask runTaskTimer(Plugin plugin, BukkitRunnable task, long delay, long period) throws IllegalArgumentException;
@@ -313,6 +355,14 @@ public interface BukkitScheduler {
/**
* @deprecated Use {@link BukkitRunnable#runTaskTimerAsynchronously(Plugin, long, long)}
* @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 for the first
* time
* @param period the ticks to wait between runs
* @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null
*/
@Deprecated
public BukkitTask runTaskTimerAsynchronously(Plugin plugin, BukkitRunnable task, long delay, long period) throws IllegalArgumentException;