docs

src/main/java/com/github/kaktushose/jda/commands/definitions/interactions/InteractionRegistry.java

@@ -23,6 +23,7 @@
 
 import static com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition;
 
+/// Central registry for all [InteractionDefinition]s.
 public record InteractionRegistry(DependencyInjector dependencyInjector,
                                   ValidatorRegistry validatorRegistry,
                                   LocalizationFunction localizationFunction,
@@ -32,10 +33,18 @@ public record InteractionRegistry(DependencyInjector dependencyInjector,
 
     private static final Logger log = LoggerFactory.getLogger(InteractionRegistry.class);
 
+    /// Constructs a new [InteractionRegistry]
+    /// @param injector the [DependencyInjector] to use
+    /// @param registry the corresponding [ValidatorRegistry]
+    /// @param function the [LocalizationFunction] to use
+    /// @param descriptor the [Descriptor] to use
     public InteractionRegistry(DependencyInjector injector, ValidatorRegistry registry, LocalizationFunction function, Descriptor descriptor) {
         this(injector, registry, function, descriptor, new HashSet<>());
     }
 
+    /// Scans all given classes and registers the interactions defined in them.
+    ///
+    /// @param classes the [Class]es to build the interactions from
     public void index(Iterable<Class<?>> classes) {
         int oldSize = definitions.size();
 

src/main/java/com/github/kaktushose/jda/commands/definitions/interactions/ModalDefinition.java

@@ -6,6 +6,7 @@
 import com.github.kaktushose.jda.commands.definitions.description.ParameterDescription;
 import com.github.kaktushose.jda.commands.definitions.features.CustomIdJDAEntity;
 import com.github.kaktushose.jda.commands.definitions.features.JDAEntity;
+import com.github.kaktushose.jda.commands.definitions.interactions.command.ParameterDefinition;
 import com.github.kaktushose.jda.commands.dispatching.events.interactions.ModalEvent;
 import com.github.kaktushose.jda.commands.internal.Helpers;
 import net.dv8tion.jda.api.interactions.components.text.TextInput;
@@ -95,7 +96,8 @@ public String displayName() {
         return title;
     }
 
-
+    /// Representation of a modal text input defined by
+    /// [`TextInput`][com.github.kaktushose.jda.commands.annotations.interactions.TextInput]
     public record TextInputDefinition(
             @NotNull String label,
             @NotNull String placeholder,
@@ -106,6 +108,10 @@ public record TextInputDefinition(
             boolean required
     ) implements JDAEntity<TextInput>, Definition {
 
+        /// Builds a new [TextInputDefinition] from the given [ParameterDefinition]
+        ///
+        /// @param parameter the [ParameterDefinition] to build the [TextInputDefinition] from
+        /// @return the new [TextInputDefinition]
         public static Optional<TextInputDefinition> build(ParameterDescription parameter) {
             var optional = parameter.annotation(com.github.kaktushose.jda.commands.annotations.interactions.TextInput.class);
 
@@ -135,8 +141,10 @@ public static Optional<TextInputDefinition> build(ParameterDescription parameter
             return label;
         }
 
+        /// Transforms this definition into a [TextInput]
+        @NotNull
         @Override
-        public @NotNull TextInput toJDAEntity() {
+        public TextInput toJDAEntity() {
             var textInput = TextInput.create(label, label, style).setRequired(required);
 
             if (minValue != -1) {