Properly document form commands

Author: Defective4

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/AddFieldFormSubcommand.java

@@ -2,6 +2,7 @@
 
 import java.util.Arrays;
 import java.util.Optional;
+
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormField;
@@ -17,7 +18,14 @@
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand;
 
 /**
- * The `/form add-field` command.
+ * The `/form add-field` command. This command allows for modification of
+ * {@link FormData} by adding new fields to it. See
+ * {@link RemoveFieldFormSubcommand} for the command used to remove fields from
+ * a form.<br>
+ * Currently, due to Discord limitations, only 5 fields are allowed per form.
+ * Trying to add more fields will have no effect.
+ * 
+ * @see FormData
  */
 public class AddFieldFormSubcommand extends Subcommand implements AutoCompletable {
 

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/AttachFormSubcommand.java

@@ -5,6 +5,7 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
+
 import net.discordjug.javabot.systems.staff_commands.forms.FormInteractionManager;
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
@@ -29,7 +30,14 @@
 import xyz.dynxsty.dih4jda.util.ComponentIdBuilder;
 
 /**
- * The `/form attach` command.
+ * The `/form attach` command. This command can be used to attach a form to an
+ * existing message. "Attaching" a form to message in this case mean that the
+ * bot will modify the target message with a button, that when interacted with,
+ * will bring up a modal where the user can input their data. See
+ * {@link DetachFormSubcommand} for a command used to detach the form from a
+ * message.
+ * 
+ * @see FormData
  */
 public class AttachFormSubcommand extends Subcommand implements AutoCompletable {
 

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/CloseFormSubcommand.java

@@ -1,6 +1,7 @@
 package net.discordjug.javabot.systems.staff_commands.forms.commands;
 
 import java.util.Optional;
+
 import net.discordjug.javabot.data.config.BotConfig;
 import net.discordjug.javabot.systems.staff_commands.forms.FormInteractionManager;
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
@@ -17,7 +18,11 @@
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand;
 
 /**
- * The `/form close` command.
+ * The `/form close` command. This command closes a form. A closed form doesn't
+ * accept any new submissions. See {@link ReopenFormSubcommand} for a command
+ * that can be used to re-open a closed form.
+ * 
+ * @see FormData
  */
 public class CloseFormSubcommand extends Subcommand implements AutoCompletable {
 

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/CreateFormSubcommand.java

@@ -3,6 +3,7 @@
 import java.time.Instant;
 import java.util.List;
 import java.util.Optional;
+
 import net.discordjug.javabot.systems.staff_commands.forms.FormInteractionManager;
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
@@ -15,6 +16,11 @@
 
 /**
  * The `/form create` command.
+ * This command creates a new, empty form.
+ * Newly created forms have no fields, and thus can't be attached (See {@link AttachFormSubcommand}) to messages.
+ * Use {@link AddFieldFormSubcommand} to add new fields to the form.
+ * 
+ * @see FormData
  */
 public class CreateFormSubcommand extends Subcommand {
 

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/DeleteFormSubcommand.java

@@ -1,6 +1,7 @@
 package net.discordjug.javabot.systems.staff_commands.forms.commands;
 
 import java.util.Optional;
+
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
 import net.dv8tion.jda.api.events.interaction.command.CommandAutoCompleteInteractionEvent;
@@ -15,7 +16,12 @@
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand;
 
 /**
- * The `/form delete` command.
+ * The `/form delete` command. Deletes an existing form, also detaching it from
+ * a message if it's attached at the time of running this command. This command
+ * does NOT delete submission records from the database, see
+ * {@link SubmissionsDeleteFormSubcommand}.
+ * 
+ * @see FormData
  */
 public class DeleteFormSubcommand extends Subcommand implements AutoCompletable {
 

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/DetachFormSubcommand.java

@@ -3,6 +3,7 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
+
 import net.discordjug.javabot.systems.staff_commands.forms.FormInteractionManager;
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
@@ -24,7 +25,12 @@
 import xyz.dynxsty.dih4jda.util.ComponentIdBuilder;
 
 /**
- * The `/form detach` command.
+ * The `/form detach` command. This command detaches this form from the message
+ * it's attached to. Detaching a form means that any buttons that could be used
+ * to bring its input dialog will be removed. See {@link AttachFormSubcommand}
+ * for a command for attaching the form to a message.
+ * 
+ * @see FormData
  */
 public class DetachFormSubcommand extends Subcommand implements AutoCompletable {
 

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/DetailsFormSubcommand.java

@@ -2,6 +2,7 @@
 
 import java.time.Instant;
 import java.util.Optional;
+
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
 import net.dv8tion.jda.api.EmbedBuilder;
@@ -20,7 +21,11 @@
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand;
 
 /**
- * The `/form details` command.
+ * The `/form details` command. Displays information about the specified form.
+ * The information is sent as a non-ephemeral embed in the same channel this
+ * command is executed in.
+ * 
+ * @see FormData
  */
 public class DetailsFormSubcommand extends Subcommand implements AutoCompletable {
 

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/ModifyFormSubcommand.java

@@ -2,6 +2,7 @@
 
 import java.time.Instant;
 import java.util.Optional;
+
 import net.discordjug.javabot.systems.staff_commands.forms.FormInteractionManager;
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
@@ -17,7 +18,9 @@
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand;
 
 /**
- * The `/form modify` command.
+ * The `/form modify` command. Modifies attributes of an existing form.
+ * 
+ * @see FormData
  */
 public class ModifyFormSubcommand extends Subcommand implements AutoCompletable {
 
@@ -33,7 +36,6 @@ public ModifyFormSubcommand(FormsRepository formsRepo) {
 		setCommandData(new SubcommandData("modify", "Modify an existing form").addOptions(
 				new OptionData(OptionType.INTEGER, "form-id", "ID of the form to modify", true, true),
 				new OptionData(OptionType.STRING, "title", "Form title (shown in modal)"),
-				new OptionData(OptionType.STRING, "json", "Form inputs data"),
 				new OptionData(OptionType.CHANNEL, "submit-channel", "Channel to log form submissions in"),
 				new OptionData(OptionType.STRING, "submit-message",
 						"Message displayed to the user once they submit the form"),

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/RemoveFieldFormSubcommand.java

@@ -3,6 +3,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
+
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormData;
 import net.discordjug.javabot.systems.staff_commands.forms.model.FormField;
@@ -17,7 +18,10 @@
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand;
 
 /**
- * The `/form remove-field` command.
+ * The `/form remove-field` command. This command removes a field from the form.
+ *
+ * @see AddFieldFormSubcommand
+ * @see FormData
  */
 public class RemoveFieldFormSubcommand extends Subcommand implements AutoCompletable {
 

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/commands/ReopenFormSubcommand.java

@@ -1,6 +1,7 @@
 package net.discordjug.javabot.systems.staff_commands.forms.commands;
 
 import java.util.Optional;
+
 import net.discordjug.javabot.data.config.BotConfig;
 import net.discordjug.javabot.systems.staff_commands.forms.FormInteractionManager;
 import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;
@@ -17,7 +18,10 @@
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand;
 
 /**
- * The `/form reopen` command.
+ * The `/form reopen` command. Reopens a closed form, allowing new submissions.
+ * 
+ * @see CloseFormSubcommandr
+ * @see FormData
  */
 public class ReopenFormSubcommand extends Subcommand implements AutoCompletable {