updated some docs

Author: jasonlessenich

src/main/java/com/dynxsty/dih4jda/interactions/ComponentIdBuilder.java

@@ -4,7 +4,7 @@
 import java.util.stream.Collectors;
 
 /**
- * Utility class that allows for easy and consistent component-id building.
+ * Utility class that allows for easy and consistent Component-ID building.
  *
  * @since v1.4
  */

src/main/java/com/dynxsty/dih4jda/interactions/commands/CommandRequirements.java

@@ -6,6 +6,12 @@
 import java.util.HashSet;
 import java.util.Set;
 
+/**
+ * Allows to set requirements that must be met in order to execute the command.
+ * If a requirement isn't met, this will fire the corresponding event in {@link com.dynxsty.dih4jda.events.DIH4JDAListenerAdapter}.
+ *
+ * @since v1.5
+ */
 public abstract class CommandRequirements extends ComponentHandler {
 	private final Set<Permission> requiredPermissions = new HashSet<>();
 	private final Set<Long> requiredUsers = new HashSet<>();

src/main/java/com/dynxsty/dih4jda/interactions/commands/ComponentHandler.java

@@ -12,7 +12,8 @@
 import java.util.List;
 
 /**
- * Abstract class that represents an executable Slash Command (excluding Subcommand Groups).
+ * Allows to set Component-IDs which get handled within the extending class.
+ * Best used in combination with {@link ComponentIdBuilder}.
  *
  * @since v1.4
  */
@@ -40,15 +41,15 @@ public boolean shouldHandleAutoComplete() {
 	 * override its method.
 	 *
 	 * <pre>{@code
-	 * public class PingCommand extends GuildSlashCommand implements AutoCompleteHandler {
+	 * public class PingCommand extends SlashCommand implements AutoCompleteHandler {
 	 *
-	 *     public PingCommand(Guild guild) {
+	 *     public PingCommand() {
 	 *         setCommandData(Commands.slash("ping", "Ping someone").addOption(OptionType.STRING, "user-id", "The user's id"));
 	 *         enableAutoCompleteHandling();
 	 *     }
 	 *
 	 *     @Override
-	 *     public void handleSlashCommand(SlashCommandInteractionEvent event) {
+	 *     public void execute(SlashCommandInteractionEvent event) {
 	 *         OptionMapping mapping = event.getOption("user-id");
 	 *         String userId = mapping.getAsString();
 	 *         event.replyFormat("Ping! <@%s>", userId).queue();
@@ -93,7 +94,7 @@ public List<String> getHandledButtonIds() {
 	 * <pre>{@code
 	 * public class TestCommand extends SlashCommand {
 	 *
-	 *     public TestCommand(Guild guild) {
+	 *     public TestCommand() {
 	 *         setCommandData(Commands.slash("test", "test description"));
 	 *         handleButtonIds("test-button");
 	 *     }
@@ -136,7 +137,7 @@ public void handleButtonIds(String... handledButtonIds) {
 	 * <pre>{@code
 	 * public class TestCommand extends SlashCommand {
 	 *
-	 *     public TestCommand(Guild guild) {
+	 *     public TestCommand() {
 	 *         setCommandData(Commands.slash("test", "test description"));
 	 *         handleButtonIds("test-button");
 	 *     }
@@ -184,13 +185,13 @@ public List<String> getHandledSelectMenuIds() {
 	 * <pre>{@code
 	 * public class TestCommand extends GuildSlashCommand implements SelectMenuHandler {
 	 *
-	 *     public TestCommand(Guild guild) {
+	 *     public TestCommand() {
 	 *         setCommandData(Commands.slash("test", "test description"));
 	 *         handleSelectMenuIds("test-select-menu");
 	 *     }
 	 *
 	 *    @Override
-	 *    public void handleSlashCommand(SlashCommandInteractionEvent event) {
+	 *    public void execute(SlashCommandInteractionEvent event) {
 	 * 		List<Role> roles = [...]
 	 * 		SelectMenu.Builder menu = SelectMenu.create("test-select-menu");
 	 * 		for (Role role : roles) {
@@ -224,7 +225,7 @@ public void handleSelectMenuIds(String... handledSelectMenuIds) {
 	 * <pre>{@code
 	 * public class TestCommand extends SlashCommand {
 	 *
-	 *     public TestCommand(Guild guild) {
+	 *     public TestCommand() {
 	 *         setCommandData(Commands.slash("test", "test description"));
 	 *         handleSelectMenuIds("test-select-menu");
 	 *     }
@@ -270,7 +271,7 @@ public List<String> getHandledModalIds() {
 	 * <pre>{@code
 	 * public class TestCommand extends SlashCommand {
 	 *
-	 *     public TestCommand(Guild guild) {
+	 *     public TestCommand() {
 	 *         setCommandData(Commands.slash("test", "test description"));
 	 *         handleModalIds("test-modal");
 	 *     }
@@ -324,7 +325,7 @@ public void handleModalIds(String... handledModalIds) {
 	 * <pre>{@code
 	 * public class TestCommand extends SlashCommand {
 	 *
-	 *     public TestCommand(Guild guild) {
+	 *     public TestCommand() {
 	 *         setCommandData(Commands.slash("test", "test description"));
 	 *         handleModalIds("test-modal");
 	 *     }

src/main/java/com/dynxsty/dih4jda/interactions/commands/ContextCommand.java

@@ -11,6 +11,8 @@
  *
  * @see ContextCommand.User#execute(UserContextInteractionEvent)
  * @see ContextCommand.Message#execute(MessageContextInteractionEvent)
+ *
+ * @since v1.5
  */
 public abstract class ContextCommand extends ExecutableCommand {
 	private CommandData commandData;
@@ -42,14 +44,14 @@ public abstract static class User extends ContextCommand {
 		 * Abstract method that must be implemented for all User Context Commands.
 		 *
 		 * <pre>{@code
-		 * public class PingContextMenu extends GuildContextCommand implements UserContextCommand {
+		 * public class PingContextMenu extends ContextCommand.User {
 		 *
 		 *    public PingContextMenu() {
 		 * 		this.setCommandData(Commands.user("Ping"));
 		 *    }
 		 *
 		 *    @Override
-		 *    public void handleUserContextInteraction(UserContextInteractionEvent event) {
+		 *    public void execute(UserContextInteractionEvent event) {
 		 * 		event.reply("Pong!").queue();
 		 *    }
 		 * }}

src/main/java/com/dynxsty/dih4jda/interactions/commands/ExecutableCommand.java

@@ -10,6 +10,14 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+/**
+ * Represents a single, executable command.
+ *
+ * @see ContextCommand
+ * @see SlashCommand
+ *
+ * @since v1.5
+ */
 public abstract class ExecutableCommand extends CommandRequirements {
 	private final Set<Long> whitelistedGuilds = new HashSet<>();
 	private final Set<Long> blacklistedGuilds = new HashSet<>();

src/main/java/com/dynxsty/dih4jda/interactions/commands/SlashCommand.java

@@ -6,9 +6,11 @@
 import net.dv8tion.jda.api.interactions.commands.build.SubcommandGroupData;
 
 /**
- * Model class which represents a single Slash Command.
+ * Represents a single Slash Command.
  *
  * @see SlashCommand#execute(SlashCommandInteractionEvent)
+ *
+ * @since v1.5
  */
 public abstract class SlashCommand extends ExecutableCommand {
 
@@ -25,7 +27,7 @@ protected SlashCommand() {
 	 * <pre>{@code
 	 * public class PingCommand extends SlashCommand {
 	 *
-	 *     public PingCommand(Guild guild) {
+	 *     public PingCommand() {
 	 *         setCommandData(Commands.slash("ping", "Ping!"));
 	 *     }
 	 *
@@ -112,7 +114,7 @@ public void setSubcommandData(SubcommandData subCommandData) {
 		 * <pre>{@code
 		 * public class PingCommand extends SlashCommand.Subcommand {
 		 *
-		 *     public PingCommand(Guild guild) {
+		 *     public PingCommand() {
 		 *         setSubcommandData(Commands.slash("ping", "Ping!"));
 		 *     }
 		 *

src/main/java/com/dynxsty/dih4jda/util/Pair.java

@@ -1,7 +1,7 @@
 package com.dynxsty.dih4jda.util;
 
 /**
- * Data class which holds two values.
+ * A Pair of two elements.
  *
  * @param <F> The first value.
  * @param <S> The second value.