SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve javadoc in 26 files.

Browse Source 
Addresses:
BUKKIT-1643, BUKKIT-1868, BUKKIT-1846, BUKKIT-2632, BUKKIT-3196,
BUKKIT-3187, BUKKIT-3198, BUKKIT-3200, BUKKIT-3201 and BUKKIT-3417.

By: feildmaster <admin@feildmaster.com>
This commit is contained in:
Bukkit/Spigot
2013-01-22 15:09:24 -06:00
parent c5392313d3
commit 8065c9095a
26 changed files with 253 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
paper-api/src/main/java/org/bukkit/scheduler/BukkitScheduler.java
View File

@@ -8,8 +8,8 @@ import java.util.List;
public interface BukkitScheduler {
/**
* Schedules a once off task to occur after a delay
* This task will be executed by the main server thread
* Schedules a once off task to occur after a delay.
* This task will be executed by the main server thread.
*
* @param plugin Plugin that owns the task
* @param task Task to be executed
@@ -19,8 +19,8 @@ public interface BukkitScheduler {
public int scheduleSyncDelayedTask(Plugin plugin, Runnable task, long delay);
/**
* Schedules a once off task to occur as soon as possible
* This task will be executed by the main server thread
* Schedules a once off task to occur as soon as possible.
* This task will be executed by the main server thread.
*
* @param plugin Plugin that owns the task
* @param task Task to be executed
@@ -29,8 +29,8 @@ public interface BukkitScheduler {
public int scheduleSyncDelayedTask(Plugin plugin, Runnable task);
/**
* Schedules a repeating task
* This task will be executed by the main server thread
* Schedules a repeating task.
* This task will be executed by the main server thread.
*
* @param plugin Plugin that owns the task
* @param task Task to be executed
@@ -44,8 +44,8 @@ public interface BukkitScheduler {
* <b>Asynchronous tasks should never access any API in Bukkit.
* Great care should be taken to assure the thread-safety of asynchronous tasks.</b>
* <br>
* <br>Schedules a once off task to occur after a delay,
* This task will be executed by a thread managed by the scheduler
* <br>Schedules a once off task to occur after a delay.
* This task will be executed by a thread managed by the scheduler.
*
* @param plugin Plugin that owns the task
* @param task Task to be executed
@@ -61,7 +61,7 @@ public interface BukkitScheduler {
* Great care should be taken to assure the thread-safety of asynchronous tasks.</b>
* <br>
* <br>Schedules a once off task to occur as soon as possible.
* This task will be executed by a thread managed by the scheduler
* This task will be executed by a thread managed by the scheduler.
*
* @param plugin Plugin that owns the task
* @param task Task to be executed
@@ -76,7 +76,7 @@ public interface BukkitScheduler {
* Great care should be taken to assure the thread-safety of asynchronous tasks.</b>
* <br>
* <br>Schedules a repeating task.
* This task will be executed by a thread managed by the scheduler
* This task will be executed by a thread managed by the scheduler.
*
* @param plugin Plugin that owns the task
* @param task Task to be executed
@@ -90,10 +90,10 @@ public interface BukkitScheduler {
/**
* Calls a method on the main thread and returns a Future object
* This task will be executed by the main server thread
* This task will be executed by the main server thread.
* <p />
* Note: The Future.get() methods must NOT be called from the main thread
* Note2: There is at least an average of 10ms latency until the isDone() method returns true
* Note: The Future.get() methods must NOT be called from the main thread.
* Note2: There is at least an average of 10ms latency until the isDone() method returns true.
*
* @param <T> The callable's return type
* @param plugin Plugin that owns the task
@@ -103,21 +103,21 @@ public interface BukkitScheduler {
public <T> Future<T> callSyncMethod(Plugin plugin, Callable<T> task);
/**
* Removes task from scheduler
* Removes task from scheduler.
*
* @param taskId Id number of task to be removed
*/
public void cancelTask(int taskId);
/**
* Removes all tasks associated with a particular plugin from the scheduler
* Removes all tasks associated with a particular plugin from the scheduler.
*
* @param plugin Owner of tasks to be removed
*/
public void cancelTasks(Plugin plugin);
/**
* Removes all tasks from the scheduler
* Removes all tasks from the scheduler.
*/
public void cancelAllTasks();
@@ -216,7 +216,7 @@ public interface BukkitScheduler {
public BukkitTask runTaskLaterAsynchronously(Plugin plugin, Runnable task, long delay) throws IllegalArgumentException;
/**
* Returns a task that will repeatedly run until cancelled, starting after the specified number of server ticks
* Returns a task that will repeatedly run until cancelled, starting after the specified number of server ticks.
*
* @param plugin the reference to the plugin scheduling task
* @param task the task to be run