Chronika/Bukkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
A special thanks goes to @aerouk for almost all of the changes found here.
This commit is contained in:
Wesley Wolfe
2013-12-15 01:07:43 -05:00
parent ad1f1c2c75
commit 8a1dbc38da
310 changed files with 4218 additions and 2904 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -33,10 +33,10 @@ public abstract class BukkitRunnable implements Runnable {
}
/**
* <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 this in the Bukkit scheduler to run asynchronously.
* <b>Asynchronous tasks should never access any API in Bukkit. Great care
* should be taken to assure the thread-safety of asynchronous tasks.</b>
* <p>
* Schedules this in the Bukkit scheduler to run asynchronously.
*
* @param plugin the reference to the plugin scheduling task
* @return a BukkitTask that contains the id number
@@ -65,10 +65,11 @@ public abstract class BukkitRunnable implements Runnable {
}
/**
* <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 this to run asynchronously after the specified number of server ticks.
* <b>Asynchronous tasks should never access any API in Bukkit. Great care
* should be taken to assure the thread-safety of asynchronous tasks.</b>
* <p>
* Schedules this to run asynchronously 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
@@ -83,7 +84,8 @@ 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
@@ -99,18 +101,21 @@ public abstract class BukkitRunnable implements Runnable {
}
/**
* <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 this to repeatedly run asynchronously until cancelled, starting after the specified number of server ticks.
* <b>Asynchronous tasks should never access any API in Bukkit. Great care
* should be taken to assure the thread-safety of asynchronous tasks.</b>
* <p>
* Schedules this to repeatedly run asynchronously 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 for the first time
* @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 IllegalStateException if this was already scheduled
* @see BukkitScheduler#runTaskTimerAsynchronously(Plugin, Runnable, long, long)
* @see BukkitScheduler#runTaskTimerAsynchronously(Plugin, Runnable, long,
* long)
*/
public synchronized BukkitTask runTaskTimerAsynchronously(Plugin plugin, long delay, long period) throws IllegalArgumentException, IllegalStateException {
checkState();