summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/bukkit/plugin/java/annotation/plugin/Plugin.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/bukkit/plugin/java/annotation/plugin/Plugin.java')
-rw-r--r--src/main/java/org/bukkit/plugin/java/annotation/plugin/Plugin.java6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/plugin/Plugin.java b/src/main/java/org/bukkit/plugin/java/annotation/plugin/Plugin.java
index bd0a78f..3964808 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/plugin/Plugin.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/plugin/Plugin.java
@@ -6,6 +6,12 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+
+/**
+ * Represents the required elements needed to register a Bukkit plugin.
+ * This <i>must</i> be placed in the main class of your plugin
+ * (i.e. the class that extends {@link org.bukkit.plugin.java.JavaPlugin}
+ */
@Documented
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)