Chronika/Bukkit
1
0
Fork 0
Code Issues Pull Requests Actions 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.
This commit is contained in:
feildmaster
2013-01-22 15:09:24 -06:00
parent 127e74cb56
commit bbc75c4a68
26 changed files with 253 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/java/org/bukkit/scheduler/BukkitRunnable.java
View File

@@ -10,7 +10,8 @@ public abstract class BukkitRunnable implements Runnable {
private int taskId = -1;
/**
* Attempts to cancel this task
* Attempts to cancel this task.
*
* @throws IllegalStateException if task was not scheduled yet
*/
public synchronized void cancel() throws IllegalStateException {
@@ -18,7 +19,7 @@ public abstract class BukkitRunnable implements Runnable {
}
/**
* Schedules this in the Bukkit scheduler to run on next tick
* Schedules this in the Bukkit scheduler to run on next tick.
*
* @param plugin the reference to the plugin scheduling task
* @return a BukkitTask that contains the id number
@@ -83,7 +84,7 @@ public abstract class BukkitRunnable implements Runnable {
}
/**
* Schedules this to repeatedly run until cancelled, starting after the specified number of server ticks
* Schedules this to repeatedly run until cancelled, starting after the specified number of server ticks.
*
* @param plugin the reference to the plugin scheduling task
* @param delay the ticks to wait before running the task
@@ -118,7 +119,8 @@ public abstract class BukkitRunnable implements Runnable {
}
/**
* Gets the task id for this runnable
* Gets the task id for this runnable.
*
* @return the task id that this runnable was scheduled as
* @throws IllegalStateException if task was not scheduled yet
*/