Pulling all pending Bukkit-JavaDoc changes
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:
@@ -33,10 +33,11 @@ public interface Plugin extends TabExecutor {
|
||||
public PluginDescriptionFile getDescription();
|
||||
|
||||
/**
|
||||
* Gets a {@link FileConfiguration} for this plugin, read through "config.yml"
|
||||
* Gets a {@link FileConfiguration} for this plugin, read through
|
||||
* "config.yml"
|
||||
* <p>
|
||||
* If there is a default config.yml embedded in this plugin, it will be provided
|
||||
* as a default for this Configuration.
|
||||
* If there is a default config.yml embedded in this plugin, it will be
|
||||
* provided as a default for this Configuration.
|
||||
*
|
||||
* @return Plugin configuration
|
||||
*/
|
||||
@@ -56,20 +57,26 @@ public interface Plugin extends TabExecutor {
|
||||
public void saveConfig();
|
||||
|
||||
/**
|
||||
* Saves the raw contents of the default config.yml file to the location retrievable by {@link #getConfig()}.
|
||||
* If there is no default config.yml embedded in the plugin, an empty config.yml file is saved.
|
||||
* This should fail silently if the config.yml already exists.
|
||||
* Saves the raw contents of the default config.yml file to the location
|
||||
* retrievable by {@link #getConfig()}. If there is no default config.yml
|
||||
* embedded in the plugin, an empty config.yml file is saved. This should
|
||||
* fail silently if the config.yml already exists.
|
||||
*/
|
||||
public void saveDefaultConfig();
|
||||
|
||||
/**
|
||||
* Saves the raw contents of any resource embedded with a plugin's .jar file assuming it can be found using
|
||||
* {@link #getResource(String)}. The resource is saved into the plugin's data folder using the same hierarchy
|
||||
* as the .jar file (subdirectories are preserved).
|
||||
* Saves the raw contents of any resource embedded with a plugin's .jar
|
||||
* file assuming it can be found using {@link #getResource(String)}.
|
||||
* <p>
|
||||
* The resource is saved into the plugin's data folder using the same
|
||||
* hierarchy as the .jar file (subdirectories are preserved).
|
||||
*
|
||||
* @param resourcePath the embedded resource path to look for within the plugin's .jar file. (No preceding slash).
|
||||
* @param replace if true, the embedded resource will overwrite the contents of an existing file.
|
||||
* @throws IllegalArgumentException if the resource path is null, empty, or points to a nonexistent resource.
|
||||
* @param resourcePath the embedded resource path to look for within the
|
||||
* plugin's .jar file. (No preceding slash).
|
||||
* @param replace if true, the embedded resource will overwrite the
|
||||
* contents of an existing file.
|
||||
* @throws IllegalArgumentException if the resource path is null, empty,
|
||||
* or points to a nonexistent resource.
|
||||
*/
|
||||
public void saveResource(String resourcePath, boolean replace);
|
||||
|
||||
@@ -93,7 +100,8 @@ public interface Plugin extends TabExecutor {
|
||||
public Server getServer();
|
||||
|
||||
/**
|
||||
* Returns a value indicating whether or not this plugin is currently enabled
|
||||
* Returns a value indicating whether or not this plugin is currently
|
||||
* enabled
|
||||
*
|
||||
* @return true if this plugin is enabled, otherwise false
|
||||
*/
|
||||
@@ -106,7 +114,9 @@ public interface Plugin extends TabExecutor {
|
||||
|
||||
/**
|
||||
* Called after a plugin is loaded but before it has been enabled.
|
||||
* When mulitple plugins are loaded, the onLoad() for all plugins is called before any onEnable() is called.
|
||||
* <p>
|
||||
* When mulitple plugins are loaded, the onLoad() for all plugins is
|
||||
* called before any onEnable() is called.
|
||||
*/
|
||||
public void onLoad();
|
||||
|
||||
@@ -148,17 +158,20 @@ public interface Plugin extends TabExecutor {
|
||||
public EbeanServer getDatabase();
|
||||
|
||||
/**
|
||||
* Gets a {@link ChunkGenerator} for use in a default world, as specified in the server configuration
|
||||
* Gets a {@link ChunkGenerator} for use in a default world, as specified
|
||||
* in the server configuration
|
||||
*
|
||||
* @param worldName Name of the world that this will be applied to
|
||||
* @param id Unique ID, if any, that was specified to indicate which generator was requested
|
||||
* @param id Unique ID, if any, that was specified to indicate which
|
||||
* generator was requested
|
||||
* @return ChunkGenerator for use in the default world generation
|
||||
*/
|
||||
public ChunkGenerator getDefaultWorldGenerator(String worldName, String id);
|
||||
|
||||
/**
|
||||
* Returns the primary logger associated with this server instance. The returned logger automatically
|
||||
* tags all log messages with the plugin's name.
|
||||
* Returns the primary logger associated with this server instance. The
|
||||
* returned logger automatically tags all log messages with the plugin's
|
||||
* name.
|
||||
*
|
||||
* @return Logger associated with this server
|
||||
*/
|
||||
@@ -167,7 +180,8 @@ public interface Plugin extends TabExecutor {
|
||||
/**
|
||||
* Returns the name of the plugin.
|
||||
* <p>
|
||||
* This should return the bare name of the plugin and should be used for comparison.
|
||||
* This should return the bare name of the plugin and should be used for
|
||||
* comparison.
|
||||
*
|
||||
* @return name of the plugin
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user