Cleaned up javadocs

Author: darichey

src/main/java/com/darichey/discord/api/Command.java

@@ -24,19 +24,17 @@ public class Command {
 	BiConsumer<CommandContext, FailureReason> onFailure = (context, failureReason) -> {};
 
 	/**
-	 * Initialize with the command's name
-	 *
-	 * @param name The name of the command
+	 * Initialize with the command's name.
+	 * @param name The name of the command.
 	 */
 	public Command(String name) {
 		this.name = name;
 	}
 
 	/**
-	 * The function to execute when the command is successful.
-	 *
-	 * @param function The function to execute
-	 * @return This command instance
+	 * The function to execute when the command is called.
+	 * @param function The function to execute.
+	 * @return This command instance.
 	 */
 	public Command onExecuted(Consumer<CommandContext> function) {
 		this.onExecuted = function;
@@ -45,9 +43,8 @@ public Command onExecuted(Consumer<CommandContext> function) {
 
 	/**
 	 * The function to execute when the command fails.
-	 *
-	 * @param function The function to execute
-	 * @return This command instance
+	 * @param function The function to execute.
+	 * @return This command instance.
 	 */
 	public Command onFailure(BiConsumer<CommandContext, FailureReason> function) {
 		this.onFailure = function;
@@ -56,7 +53,6 @@ public Command onFailure(BiConsumer<CommandContext, FailureReason> function) {
 
 	/**
 	 * An arbitrary value for the description of the command. This isn't used by the API.
-	 *
 	 * @param description The description.
 	 * @return This command instance.
 	 */
@@ -65,9 +61,8 @@ public Command withDescription(String description) {
 		return this;
 	}
 
-/**
+	/**
 	 * An arbitrary value for the usage of the command. This isn't used by the API.
-	 *
 	 * @param usage The usage.
 	 * @return This command instance.
 	 */
@@ -78,7 +73,6 @@ public Command withUsage(String usage) {
 
 	/**
 	 * Aliases that will also trigger this command (besides the name). No two commands may have the same alias.
-	 *
 	 * @param aliases The aliases.
 	 * @return This command instance.
 	 */
@@ -89,7 +83,6 @@ public Command withAliases(Set<String> aliases) {
 
 	/**
 	 * Aliases that will also trigger this command (besides the name). No two commands may have the same alias.
-	 *
 	 * @param aliases The aliases.
 	 * @return This command instance.
 	 */
@@ -100,7 +93,6 @@ public Command withAliases(String... aliases) {
 
 	/**
 	 * If true, the command will trigger regardless of case. (i.e. both !ping and !PiNg will trigger the command)
-	 *
 	 * @param caseSensitive Case sensitive or not.
 	 * @return This command instance.
 	 */
@@ -111,7 +103,6 @@ public Command caseSensitive(boolean caseSensitive) {
 
 	/**
 	 * If true, the message that triggered this command will automatically be deleted.
-	 *
 	 * @param deleteCommand To delete or not.
 	 * @return This command instance.
 	 */
@@ -122,9 +113,8 @@ public Command deleteCommand(boolean deleteCommand) {
 
 	/**
 	 * The set of permissions a person requires to execute this command. Failing to meet these requirements will result in {@link FailureReason#AUTHOR_MISSING_PERMISSIONS}
-	 *
 	 * @param requiredPermissions The required permissions.
-	 * @return This commnad instance.
+	 * @return This command instance.
 	 */
 	public Command requirePermissions(EnumSet<Permissions> requiredPermissions) {
 		this.requiredPermissions = requiredPermissions;

src/main/java/com/darichey/discord/api/CommandContext.java

@@ -31,28 +31,28 @@ public CommandContext(IMessage message) {
 	}
 
 	/**
-	 * @return The message object
+	 * @return The message object.
 	 */
 	public IMessage getMessage() {
 		return this.message;
 	}
 
 	/**
-	 * @return The command's name
+	 * @return The command's name.
 	 */
 	public String getName() {
 		return this.name;
 	}
 
 	/**
-	 * @return The arguments, or an empty array if there aren't any
+	 * @return The arguments, or an empty array if there aren't any.
 	 */
 	public String[] getArgs() {
 		return this.args;
 	}
 
 	/**
-	 * @return The CommandRegistry
+	 * @return The CommandRegistry of the guild this context is for.
 	 */
 	public CommandRegistry getRegistry() {
 		return this.registry;

src/main/java/com/darichey/discord/api/CommandRegistry.java

@@ -14,9 +14,8 @@ public class CommandRegistry {
 
 	/**
 	 * Get the CommandRegistry associated with the client, or create a new one if not present.
-	 *
-	 * @param client The client object to associate with
-	 * @return The CommandRegistry for the client
+	 * @param client The client object to associate with.
+	 * @return The CommandRegistry for the client.
 	 */
 	public static CommandRegistry getForClient(IDiscordClient client) {
 		if (!registries.containsKey(client)) {
@@ -29,16 +28,14 @@ public static CommandRegistry getForClient(IDiscordClient client) {
 	/**
 	 * Private so you have to use {@link CommandRegistry#getForClient(IDiscordClient)}
 	 */
-	private CommandRegistry() {
-	}
+	private CommandRegistry() {}
 
 	private List<Command> commands = new ArrayList<>();
 	private String prefix = "!";
 
 	/**
 	 * Register a command.
-	 *
-	 * @param command
+	 * @param command The command.
 	 */
 	public void register(Command command) {
 		if (!commands.stream().filter(cmd -> cmd.getName().equalsIgnoreCase(command.getName())).findFirst().isPresent()) {
@@ -58,10 +55,9 @@ public void registerAll(Command... commands) {
 
 	/**
 	 * Get a command by its name.
-	 *
-	 * @param name         The command name
-	 * @param includeAlias If aliases can be used to search, otherwise it has to be the original name
-	 * @return The command if present
+	 * @param name The command name.
+	 * @param includeAlias If aliases can be used to search, otherwise it has to be the original name.
+	 * @return An optional value of the command.
 	 */
 	public Optional<Command> getCommandByName(String name, boolean includeAlias) {
 		return commands.stream().filter(c ->
@@ -71,25 +67,23 @@ public Optional<Command> getCommandByName(String name, boolean includeAlias) {
 
 	/**
 	 * Get all commands registered.
-	 *
-	 * @return A list of commands
+	 * @return A list of commands.
 	 */
 	public List<Command> getCommands() {
 		return commands;
 	}
 
 	/**
-	 * Set the prefix to use.
-	 *
-	 * @param prefix The new prefix
+	 * Sets the prefix that commands registered to this registry will be activated by.
+	 * @param prefix The new prefix.
 	 */
 	public void setPrefix(String prefix) {
 		if (prefix == null) throw new IllegalArgumentException("The new prefix cannot be null!");
 		this.prefix = prefix;
 	}
 
 	/**
-	 * @return The prefix
+	 * @return The prefix that commands registered to this registry will be activated by.
 	 */
 	public String getPrefix() {
 		return this.prefix;