From 1c5f2a077f4731ee9f3e6e4af7cca1ca87c67276 Mon Sep 17 00:00:00 2001
From: Senmori <thesenmori@gmail.com>
Date: Tue, 27 Feb 2018 22:07:48 -0500
Subject: Update javadocs. Fix some minor formatting issues.

---
 .../java/org/bukkit/plugin/java/annotation/command/Command.java   | 1 -
 .../java/org/bukkit/plugin/java/annotation/command/Commands.java  | 1 -
 .../org/bukkit/plugin/java/annotation/dependency/Dependency.java  | 3 +++
 .../org/bukkit/plugin/java/annotation/dependency/DependsOn.java   | 1 -
 .../org/bukkit/plugin/java/annotation/dependency/LoadBefore.java  | 3 +++
 .../plugin/java/annotation/dependency/LoadBeforePlugins.java      | 2 +-
 .../bukkit/plugin/java/annotation/dependency/SoftDependency.java  | 3 +++
 .../bukkit/plugin/java/annotation/dependency/SoftDependsOn.java   | 1 -
 .../bukkit/plugin/java/annotation/permission/ChildPermission.java | 8 ++++++++
 .../org/bukkit/plugin/java/annotation/permission/Permission.java  | 2 +-
 .../org/bukkit/plugin/java/annotation/permission/Permissions.java | 1 -
 .../org/bukkit/plugin/java/annotation/plugin/Description.java     | 3 +++
 .../java/org/bukkit/plugin/java/annotation/plugin/LoadOn.java     | 5 +++++
 .../java/org/bukkit/plugin/java/annotation/plugin/LogPrefix.java  | 3 +++
 .../java/org/bukkit/plugin/java/annotation/plugin/Plugin.java     | 6 ++++++
 .../java/org/bukkit/plugin/java/annotation/plugin/Website.java    | 3 +++
 .../org/bukkit/plugin/java/annotation/plugin/author/Author.java   | 3 +++
 .../org/bukkit/plugin/java/annotation/plugin/author/Authors.java  | 3 +++
 18 files changed, 45 insertions(+), 7 deletions(-)

diff --git a/src/main/java/org/bukkit/plugin/java/annotation/command/Command.java b/src/main/java/org/bukkit/plugin/java/annotation/command/Command.java
index 9d54dee..ea3ad55 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/command/Command.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/command/Command.java
@@ -15,7 +15,6 @@ import java.lang.annotation.Target;
 @Target(ElementType.TYPE)
 @Repeatable(Commands.class)
 public @interface Command {
-
     /**
      * This command's name.
      */
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/command/Commands.java b/src/main/java/org/bukkit/plugin/java/annotation/command/Commands.java
index c98a77b..6ba1211 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/command/Commands.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/command/Commands.java
@@ -11,7 +11,6 @@ import java.lang.annotation.Target;
  *  <p>
  *  Represents a list of this plugin's registered command(s).
  */
-
 @Documented
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/dependency/Dependency.java b/src/main/java/org/bukkit/plugin/java/annotation/dependency/Dependency.java
index 42872f0..ac6e942 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/dependency/Dependency.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/dependency/Dependency.java
@@ -15,5 +15,8 @@ import java.lang.annotation.Target;
 @Retention(RetentionPolicy.SOURCE)
 @Repeatable(DependsOn.class)
 public @interface Dependency {
+    /**
+     * A plugin that is required to be present in order for this plugin to load.
+     */
     String plugin();
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/dependency/DependsOn.java b/src/main/java/org/bukkit/plugin/java/annotation/dependency/DependsOn.java
index e94d612..8d59aaa 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/dependency/DependsOn.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/dependency/DependsOn.java
@@ -16,5 +16,4 @@ import java.lang.annotation.Target;
 @Retention(RetentionPolicy.SOURCE)
 public @interface DependsOn {
     Dependency[] value() default {};
-
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/dependency/LoadBefore.java b/src/main/java/org/bukkit/plugin/java/annotation/dependency/LoadBefore.java
index 25388ea..d5ba086 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/dependency/LoadBefore.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/dependency/LoadBefore.java
@@ -17,5 +17,8 @@ import java.lang.annotation.Target;
 @Target(ElementType.TYPE)
 @Repeatable(LoadBeforePlugins.class)
 public @interface LoadBefore {
+    /**
+     * A plugin that should be loaded after your plugin
+     */
     String plugin();
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/dependency/LoadBeforePlugins.java b/src/main/java/org/bukkit/plugin/java/annotation/dependency/LoadBeforePlugins.java
index 400d1d7..67991e9 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/dependency/LoadBeforePlugins.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/dependency/LoadBeforePlugins.java
@@ -7,7 +7,7 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
- * Defines a list of plugin to load before this plugin
+ * Defines a list of plugin to load after this plugin
  */
 @Documented
 @Retention(RetentionPolicy.SOURCE)
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/dependency/SoftDependency.java b/src/main/java/org/bukkit/plugin/java/annotation/dependency/SoftDependency.java
index cc36edc..a53e16b 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/dependency/SoftDependency.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/dependency/SoftDependency.java
@@ -18,5 +18,8 @@ import java.lang.annotation.Target;
 @Target(ElementType.TYPE)
 @Repeatable(SoftDependsOn.class)
 public @interface SoftDependency {
+    /**
+     * A plugin that is required in order for this plugin to have full functionality.
+     */
     String plugin();
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/dependency/SoftDependsOn.java b/src/main/java/org/bukkit/plugin/java/annotation/dependency/SoftDependsOn.java
index 6be9631..038831d 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/dependency/SoftDependsOn.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/dependency/SoftDependsOn.java
@@ -17,7 +17,6 @@ import java.lang.annotation.Target;
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.TYPE)
 public @interface SoftDependsOn {
-
     SoftDependency[] value() default {};
 
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/permission/ChildPermission.java b/src/main/java/org/bukkit/plugin/java/annotation/permission/ChildPermission.java
index e22789e..7fe1a3d 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/permission/ChildPermission.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/permission/ChildPermission.java
@@ -13,6 +13,14 @@ import java.lang.annotation.Target;
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.SOURCE)
 public @interface ChildPermission {
+    /**
+     * If true, this child node will inherit the parent {@link Permission}'s permission.
+     * If false, this child node inherits the inverse parent permission.
+     */
     boolean inherit() default true;
+
+    /**
+     * The name of the child permission.
+     */
     String name();
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/permission/Permission.java b/src/main/java/org/bukkit/plugin/java/annotation/permission/Permission.java
index 35a72ab..58770e2 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/permission/Permission.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/permission/Permission.java
@@ -34,7 +34,7 @@ public @interface Permission {
     PermissionDefault defaultValue() default PermissionDefault.OP;
 
     /**
-     * This permission's child nodes
+     * This permission's child nodes ({@link ChildPermission})
      */
     ChildPermission[] children() default {};
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/permission/Permissions.java b/src/main/java/org/bukkit/plugin/java/annotation/permission/Permissions.java
index 9557769..8dd8581 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/permission/Permissions.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/permission/Permissions.java
@@ -11,7 +11,6 @@ import java.lang.annotation.Target;
  *  <p>
  *  Represents a list of this plugin's registered name.
  */
-
 @Documented
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.TYPE)
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/plugin/Description.java b/src/main/java/org/bukkit/plugin/java/annotation/plugin/Description.java
index 4fd72ae..137249d 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/plugin/Description.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/plugin/Description.java
@@ -16,6 +16,9 @@ import java.lang.annotation.Target;
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.TYPE)
 public @interface Description {
+    /**
+     * A human friendly description of the functionality this plugin provides.
+     */
     String desc();
 
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/plugin/LoadOn.java b/src/main/java/org/bukkit/plugin/java/annotation/plugin/LoadOn.java
index 3a63325..23716f7 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/plugin/LoadOn.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/plugin/LoadOn.java
@@ -18,5 +18,10 @@ import java.lang.annotation.Target;
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.TYPE)
 public @interface LoadOn {
+    /**
+     * Explicitly state when the plugin should be loaded.
+     * If not defined, will default to {@link PluginLoadOrder#POSTWORLD}.
+     * See {@link PluginLoadOrder}
+     */
     PluginLoadOrder loadOn();
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/plugin/LogPrefix.java b/src/main/java/org/bukkit/plugin/java/annotation/plugin/LogPrefix.java
index 52bd424..baefbff 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/plugin/LogPrefix.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/plugin/LogPrefix.java
@@ -16,5 +16,8 @@ import java.lang.annotation.Target;
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.TYPE)
 public @interface LogPrefix {
+    /**
+     * The name to use when logging to console instead of the plugin's name.
+     */
     String prefix();
 }
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)
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/plugin/Website.java b/src/main/java/org/bukkit/plugin/java/annotation/plugin/Website.java
index add83cf..aa28475 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/plugin/Website.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/plugin/Website.java
@@ -16,5 +16,8 @@ import java.lang.annotation.Target;
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.TYPE)
 public @interface Website {
+    /**
+     * The url to the website where a user can download this plugin.
+     */
     String url();
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/plugin/author/Author.java b/src/main/java/org/bukkit/plugin/java/annotation/plugin/author/Author.java
index ef63a56..e8172a2 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/plugin/author/Author.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/plugin/author/Author.java
@@ -18,5 +18,8 @@ import java.lang.annotation.Target;
 @Target(ElementType.TYPE)
 @Repeatable(Authors.class)
 public @interface Author {
+    /**
+     * The name of the person who developed this plugin.
+     */
     String name();
 }
diff --git a/src/main/java/org/bukkit/plugin/java/annotation/plugin/author/Authors.java b/src/main/java/org/bukkit/plugin/java/annotation/plugin/author/Authors.java
index 7e2673c..08ba1a3 100644
--- a/src/main/java/org/bukkit/plugin/java/annotation/plugin/author/Authors.java
+++ b/src/main/java/org/bukkit/plugin/java/annotation/plugin/author/Authors.java
@@ -6,6 +6,9 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Represents a list of author(s) for this plugin.
+ */
 @Documented
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.TYPE)
-- 
cgit v1.2.3