Add more javadoc.

Author: leMaik

src/main/java/de/craften/plugins/bkcommandapi/Command.java

@@ -2,21 +2,59 @@
 
 import java.lang.annotation.*;
 
+/**
+ * Annotation for methods in a {@link CommandHandler} that handle commands.
+ */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface Command {
+    /**
+     * The command.
+     *
+     * @return the command
+     */
     String[] value() default {};
 
+    /**
+     * The permission that is required to use this command.
+     *
+     * @return the permission that is required to use this command
+     */
     String permission() default "";
 
+    /**
+     * A string describing the usage of this command.
+     *
+     * @return a string describing the usage of this command
+     */
     String[] usage() default {};
 
+    /**
+     * The minimum number of arguments to use this command with.
+     *
+     * @return the minimum number of arguments to use this command with
+     */
     int min() default 0;
 
+    /**
+     * The maximum number of arguments to use this command with.
+     *
+     * @return the maximum number of arguments to use this command with
+     */
     int max() default 0;
 
+    /**
+     * Whether this command may be used from the console.
+     *
+     * @return whether this command may be used from the console
+     */
     boolean allowFromConsole() default false;
 
+    /**
+     * A description of this command.
+     *
+     * @return a description of this command
+     */
     String description() default "";
 }

src/main/java/de/craften/plugins/bkcommandapi/SubCommandHandler.java

@@ -100,7 +100,14 @@ public final boolean onCommand(CommandSender sender, org.bukkit.command.Command
         return false;
     }
 
-    private boolean containsAny(String[] haystack, String needle) {
+    /**
+     * Checks if the given array contains the given string (case insensitive).
+     *
+     * @param haystack array to search for the needle
+     * @param needle   string to search in the array
+     * @return true if the string was found in the array, false if not
+     */
+    private static boolean containsAny(String[] haystack, String needle) {
         for (String s : haystack) {
             if (needle.equalsIgnoreCase(s)) {
                 return true;
@@ -173,6 +180,12 @@ private void onUsageHelpCommand(CommandSender sender, String command) {
         }
     }
 
+    /**
+     * Sends the help line of the given command to the given command sender.
+     *
+     * @param sender  command sender to send the help line to
+     * @param command command to send the help line for
+     */
     protected void sendHelpLine(CommandSender sender, Command command) {
         if (command.value().length > 0) {
             sender.sendMessage("/" + parentCommand + " " + command.value()[0] + " - " + command.description());
@@ -181,6 +194,12 @@ protected void sendHelpLine(CommandSender sender, Command command) {
         }
     }
 
+    /**
+     * Sends usage help for the given command to the given command sender.
+     *
+     * @param sender  command sender to send the usage help to
+     * @param command command to send the usage help for
+     */
     protected void sendUsageHelp(CommandSender sender, Command command) {
         sender.sendMessage(command.description());
         if (command.usage().length > 0) {