Some more lib documentation

Author: MrSlimeDiamond

.gitignore

@@ -39,4 +39,6 @@ bin/
 ### Mac OS ###
 .DS_Store
 
-server/run
+server/run
+
+build.sh

lib/src/main/java/org/galliumpowered/annotation/Args.java

@@ -2,7 +2,19 @@
 
 import org.galliumpowered.command.args.ArgumentType;
 
+/**
+ * Command arguments
+ */
 public @interface Args {
+    /**
+     * The {@link ArgumentType} of the arg
+     * @return Argument type
+     */
     ArgumentType type();
+
+    /**
+     * Name/Id of the argument
+     * @return Argument name
+     */
     String name();
 }

lib/src/main/java/org/galliumpowered/annotation/PluginLifecycleListener.java

@@ -10,5 +10,9 @@
  */
 @Retention(RetentionPolicy.RUNTIME)
 public @interface PluginLifecycleListener {
+    /**
+     * The state which is listened for
+     * @return The state which is listened for
+     */
     PluginLifecycleState value();
 }

lib/src/main/java/org/galliumpowered/bridge/Bridge.java

@@ -6,18 +6,48 @@
 import java.util.Optional;
 
 /**
- * For bridging NMS to lib
+ * For bridging NMS to lib. For internal use.
  */
 public interface Bridge {
+
+    /**
+     * Regusters a command to the server
+     * @param alias The alias for the command (i.e. /example)
+     * @param permission The permission required to execute the command (i.e. "EXAMPLE)
+     */
     void registerCommand(String alias, String permission);
 
+    /**
+     *
+     * Regusters a command to the server
+     * @param alias The alias for the command (i.e. /example)
+     * @param permission The permission required to execute the command (i.e. "EXAMPLE)
+     * @param args Arguments for the command which may be required
+     */
     void registerCommand(String alias, String permission, Args[] args);
 
+    /**
+     * Get a {@link Player} by their username
+     * @param name The username of the player
+     * @return Player (or Optional.empty() if they are not found)
+     */
     Optional<Player> getPlayerByName(String name);
 
+    /**
+     * Version of Minecraft the server is running.
+     * @return Minecraft version
+     */
     String getServerVersion();
 
+    /**
+     * FOR INTERNAL USE ONLY
+     * Loads the internal plugins (id: gallium)
+     */
     void loadInternalPlugin();
 
+    /**
+     * FOR INTERNAL USE ONLY
+     * Loads the test plugin
+     */
     void loadTestPlugin();
 }

lib/src/main/java/org/galliumpowered/command/CommandCallerType.java

@@ -1,6 +1,10 @@
 package org.galliumpowered.command;
 
+/**
+ * The type the command caller is. Either the console or a player.
+ */
 public enum CommandCallerType {
     CONSOLE,
     PLAYER
+    // TODO: huh command blocks should probably be here as well
 }

lib/src/main/java/org/galliumpowered/command/CommandContext.java

@@ -18,6 +18,7 @@ public interface CommandContext {
      * @return Command arguments
      */
     String[] getCommandArgs();
+
     CommandContext ifPlayer(Consumer<Player> consumer);
 
     CommandContext ifConsole(Consumer<ConsoleCommandCaller> consumer);

lib/src/main/java/org/galliumpowered/command/CommandManager.java

@@ -65,11 +65,19 @@ private void internalRegister(String alias, MCommand cmd, PluginMetadata meta) {
         }
     }
 
+    /**
+     * Unregister a command from the server
+     * @param alias The alias of the command
+     */
     public void unregisterCommand(String alias) {
         commands.remove(alias);
         pluginCommands.remove(alias);
     }
 
+    /**
+     * Unregister all commands from a plugin
+     * @param meta The plugin's metadata
+     */
     public void unregisterAllPluginCommands(PluginMetadata meta) {
         for (String alias : pluginCommands.keySet()) {
             if (pluginCommands.get(alias) == meta) {
@@ -78,10 +86,20 @@ public void unregisterAllPluginCommands(PluginMetadata meta) {
         }
     }
 
+    /**
+     * Command names and their metadata
+     * Should not be modified under normal conditions!
+     * @return Command names and their metadata
+     */
     public HashMap<String, MCommand> getCommands() {
         return commands;
     }
 
+    /**
+     * Subcommands and their parents
+     * Should not be modified under normal conditions!
+     * @return Subcommands and their parents
+     */
     public HashMap<MCommand, MCommand> getSubcommands() {
         return subcommands;
     }

lib/src/main/java/org/galliumpowered/command/MCommand.java

@@ -7,6 +7,9 @@
 import java.util.*;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+/**
+ * Command metadata
+ */
 public class MCommand {
     Command command;
     Object clazz;

lib/src/main/java/org/galliumpowered/command/args/ArgumentType.java

@@ -1,7 +1,23 @@
 package org.galliumpowered.command.args;
 
+/**
+ * Command argument type
+ */
 public enum ArgumentType {
+    /**
+     * Takes up the remainder of the command
+     * For example, /mycommand subcommand this will be taken by greedy
+     */
     GREEDY,
+
+    /**
+     * It is a single word.
+     */
     SINGLE,
+
+    /**
+     * It is surrounded in quotes
+     * For example, /mycommand "hello there" "hello again"
+     */
     QUOTED
 }

lib/src/main/java/org/galliumpowered/config/Configuration.java

@@ -2,12 +2,33 @@
 
 import java.nio.file.Path;
 
+/**
+ * A configuration file.
+ */
 public interface Configuration {
+    /**
+     * The directory that the configuration file is in.
+     * @return Configuration directory
+     */
     Path getDirectory();
 
+    /**
+     * Name of the configuration file
+     * @return Config file name
+     */
     String getName();
 
+    /**
+     * Sets key to a value
+     * @param key Key
+     * @param value Value
+     */
     void setValue(String key, String value);
 
+    /**
+     * Gets the value of a key
+     * @param key Key
+     * @return Key value
+     */
     String getValue(String key);
 }