SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests 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.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
paper-api/src/main/java/org/bukkit/plugin/PluginLoader.java
View File

@@ -19,9 +19,11 @@ public interface PluginLoader {
*
* @param file File to attempt to load
* @return Plugin that was contained in the specified file, or null if
* unsuccessful
* @throws InvalidPluginException Thrown when the specified file is not a plugin
* @throws UnknownDependencyException If a required dependency could not be found
* unsuccessful
* @throws InvalidPluginException Thrown when the specified file is not a
* plugin
* @throws UnknownDependencyException If a required dependency could not
* be found
*/
public Plugin loadPlugin(File file) throws InvalidPluginException, UnknownDependencyException;
@@ -29,8 +31,10 @@ public interface PluginLoader {
* Loads a PluginDescriptionFile from the specified file
*
* @param file File to attempt to load from
* @return A new PluginDescriptionFile loaded from the plugin.yml in the specified file
* @throws InvalidDescriptionException If the plugin description file could not be created
* @return A new PluginDescriptionFile loaded from the plugin.yml in the
* specified file
* @throws InvalidDescriptionException If the plugin description file
* could not be created
*/
public PluginDescriptionFile getPluginDescription(File file) throws InvalidDescriptionException;
@@ -42,7 +46,8 @@ public interface PluginLoader {
public Pattern[] getPluginFileFilters();
/**
* Creates and returns registered listeners for the event classes used in this listener
* Creates and returns registered listeners for the event classes used in
* this listener
*
* @param listener The object that will handle the eventual call back
* @param plugin The plugin to use when creating registered listeners
@@ -53,7 +58,8 @@ public interface PluginLoader {
/**
* Enables the specified plugin
* <p>
* Attempting to enable a plugin that is already enabled will have no effect
* Attempting to enable a plugin that is already enabled will have no
* effect
*
* @param plugin Plugin to enable
*/