mirror of
https://github.com/PaperMC/Paper.git
synced 2025-08-11 18:22:08 -07:00
Pulling all pending Bukkit-JavaDoc changes
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
@@ -13,7 +13,7 @@ import com.avaje.ebean.EbeanServer;
|
||||
|
||||
/**
|
||||
* Represents a Plugin
|
||||
* <p />
|
||||
* <p>
|
||||
* The use of {@link PluginBase} is recommended for actual Implementation
|
||||
*/
|
||||
public interface Plugin extends TabExecutor {
|
||||
@@ -34,7 +34,7 @@ public interface Plugin extends TabExecutor {
|
||||
|
||||
/**
|
||||
* Gets a {@link FileConfiguration} for this plugin, read through "config.yml"
|
||||
* <p />
|
||||
* <p>
|
||||
* If there is a default config.yml embedded in this plugin, it will be provided
|
||||
* as a default for this Configuration.
|
||||
*
|
||||
|
@@ -2,7 +2,7 @@ package org.bukkit.plugin;
|
||||
|
||||
/**
|
||||
* Represents a base {@link Plugin}
|
||||
* <p />
|
||||
* <p>
|
||||
* Extend this class if your plugin is not a {@link org.bukkit.plugin.java.JavaPlugin}
|
||||
*/
|
||||
public abstract class PluginBase implements Plugin {
|
||||
|
@@ -52,7 +52,7 @@ public interface PluginLoader {
|
||||
|
||||
/**
|
||||
* Enables the specified plugin
|
||||
* <p />
|
||||
* <p>
|
||||
* Attempting to enable a plugin that is already enabled will have no effect
|
||||
*
|
||||
* @param plugin Plugin to enable
|
||||
@@ -61,7 +61,7 @@ public interface PluginLoader {
|
||||
|
||||
/**
|
||||
* Disables the specified plugin
|
||||
* <p />
|
||||
* <p>
|
||||
* Attempting to disable a plugin that is not enabled will have no effect
|
||||
*
|
||||
* @param plugin Plugin to disable
|
||||
|
@@ -24,7 +24,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Checks if the given plugin is loaded and returns it when applicable
|
||||
* <p />
|
||||
* <p>
|
||||
* Please note that the name of the plugin is case-sensitive
|
||||
*
|
||||
* @param name Name of the plugin to check
|
||||
@@ -41,7 +41,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Checks if the given plugin is enabled or not
|
||||
* <p />
|
||||
* <p>
|
||||
* Please note that the name of the plugin is case-sensitive.
|
||||
*
|
||||
* @param name Name of the plugin to check
|
||||
@@ -59,7 +59,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Loads the plugin in the specified file
|
||||
* <p />
|
||||
* <p>
|
||||
* File must be valid according to the current enabled Plugin interfaces
|
||||
*
|
||||
* @param file File containing the plugin to load
|
||||
@@ -131,7 +131,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Enables the specified plugin
|
||||
* <p />
|
||||
* <p>
|
||||
* Attempting to enable a plugin that is already enabled will have no effect
|
||||
*
|
||||
* @param plugin Plugin to enable
|
||||
@@ -140,7 +140,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Disables the specified plugin
|
||||
* <p />
|
||||
* <p>
|
||||
* Attempting to disable a plugin that is not enabled will have no effect
|
||||
*
|
||||
* @param plugin Plugin to disable
|
||||
@@ -157,7 +157,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Adds a {@link Permission} to this plugin manager.
|
||||
* <p />
|
||||
* <p>
|
||||
* If a permission is already defined with the given name of the new permission,
|
||||
* an exception will be thrown.
|
||||
*
|
||||
@@ -168,9 +168,9 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Removes a {@link Permission} registration from this plugin manager.
|
||||
* <p />
|
||||
* <p>
|
||||
* If the specified permission does not exist in this plugin manager, nothing will happen.
|
||||
* <p />
|
||||
* <p>
|
||||
* Removing a permission registration will <b>not</b> remove the permission from any {@link Permissible}s that have it.
|
||||
*
|
||||
* @param perm Permission to remove
|
||||
@@ -179,9 +179,9 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Removes a {@link Permission} registration from this plugin manager.
|
||||
* <p />
|
||||
* <p>
|
||||
* If the specified permission does not exist in this plugin manager, nothing will happen.
|
||||
* <p />
|
||||
* <p>
|
||||
* Removing a permission registration will <b>not</b> remove the permission from any {@link Permissible}s that have it.
|
||||
*
|
||||
* @param name Permission to remove
|
||||
@@ -198,7 +198,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Recalculates the defaults for the given {@link Permission}.
|
||||
* <p />
|
||||
* <p>
|
||||
* This will have no effect if the specified permission is not registered here.
|
||||
*
|
||||
* @param perm Permission to recalculate
|
||||
@@ -207,7 +207,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Subscribes the given Permissible for information about the requested Permission, by name.
|
||||
* <p />
|
||||
* <p>
|
||||
* If the specified Permission changes in any form, the Permissible will be asked to recalculate.
|
||||
*
|
||||
* @param permission Permission to subscribe to
|
||||
@@ -233,7 +233,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Subscribes to the given Default permissions by operator status
|
||||
* <p />
|
||||
* <p>
|
||||
* If the specified defaults change in any form, the Permissible will be asked to recalculate.
|
||||
*
|
||||
* @param op Default list to subscribe to
|
||||
@@ -259,7 +259,7 @@ public interface PluginManager {
|
||||
|
||||
/**
|
||||
* Gets a set of all registered permissions.
|
||||
* <p />
|
||||
* <p>
|
||||
* This set is a copy and will not be modified live.
|
||||
*
|
||||
* @return Set containing all current registered permissions
|
||||
|
@@ -279,7 +279,7 @@ public final class SimplePluginManager implements PluginManager {
|
||||
|
||||
/**
|
||||
* Loads the plugin in the specified file
|
||||
* <p />
|
||||
* <p>
|
||||
* File must be valid according to the current enabled Plugin interfaces
|
||||
*
|
||||
* @param file File containing the plugin to load
|
||||
@@ -327,7 +327,7 @@ public final class SimplePluginManager implements PluginManager {
|
||||
|
||||
/**
|
||||
* Checks if the given plugin is loaded and returns it when applicable
|
||||
* <p />
|
||||
* <p>
|
||||
* Please note that the name of the plugin is case-sensitive
|
||||
*
|
||||
* @param name Name of the plugin to check
|
||||
@@ -343,7 +343,7 @@ public final class SimplePluginManager implements PluginManager {
|
||||
|
||||
/**
|
||||
* Checks if the given plugin is enabled or not
|
||||
* <p />
|
||||
* <p>
|
||||
* Please note that the name of the plugin is case-sensitive.
|
||||
*
|
||||
* @param name Name of the plugin to check
|
||||
|
@@ -223,7 +223,7 @@ public abstract class JavaPlugin extends PluginBase {
|
||||
|
||||
/**
|
||||
* Initializes this plugin with the given variables.
|
||||
* <p />
|
||||
* <p>
|
||||
* This method should never be called manually.
|
||||
*
|
||||
* @param loader PluginLoader that is responsible for this plugin
|
||||
|
@@ -161,7 +161,7 @@ public interface Messenger {
|
||||
|
||||
/**
|
||||
* Checks if the specified plugin message listener registration is valid.
|
||||
* <p />
|
||||
* <p>
|
||||
* A registration is considered valid if it has not be unregistered and that the plugin
|
||||
* is still enabled.
|
||||
*
|
||||
|
@@ -9,7 +9,7 @@ import org.bukkit.plugin.Plugin;
|
||||
public interface PluginMessageRecipient {
|
||||
/**
|
||||
* Sends this recipient a Plugin Message on the specified outgoing channel.
|
||||
* <p />
|
||||
* <p>
|
||||
* The message may not be larger than {@link Messenger#MAX_MESSAGE_SIZE} bytes, and the plugin must be registered to send
|
||||
* messages on the specified channel.
|
||||
*
|
||||
|
Reference in New Issue
Block a user