Document packages net.md_5.bungee.api.dialog.action and net.md_5.bungee.api.dialog.body.

Author: md-5

dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogAction.java

@@ -4,13 +4,25 @@
 import lombok.Data;
 import net.md_5.bungee.api.chat.BaseComponent;
 
+/**
+ * Represents a dialog action which will usually appear as a button.
+ */
 @Data
 @AllArgsConstructor
 public class DialogAction
 {
 
+    /**
+     * The text label of the button, mandatory.
+     */
     private BaseComponent label;
+    /**
+     * The hover tooltip of the button.
+     */
     private BaseComponent tooltip;
+    /**
+     * The width of the button (default: 150).
+     */
     private int width;
 
     public DialogAction(BaseComponent label)

dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogClickAction.java

@@ -8,13 +8,19 @@
 import net.md_5.bungee.api.chat.BaseComponent;
 import net.md_5.bungee.api.chat.ClickEvent;
 
+/**
+ * Represents a button which may be clicked.
+ */
 @Data
 @Accessors(fluent = true)
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 public class DialogClickAction extends DialogAction
 {
 
+    /**
+     * The optional action to take on click.
+     */
     @SerializedName("on_click")
     private ClickEvent onClick;
 

dialog/src/main/java/net/md_5/bungee/api/dialog/action/DialogSubmitAction.java

@@ -8,14 +8,25 @@
 import net.md_5.bungee.api.chat.BaseComponent;
 import net.md_5.bungee.api.dialog.submit.DialogSubmission;
 
+/**
+ * Represents a dialog button associated with the submission of a form dialog
+ * containing inputs.
+ */
 @Data
 @Accessors(fluent = true)
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 public class DialogSubmitAction extends DialogAction
 {
 
+    /**
+     * The ID of the button, used to distinguish submissions initiated via
+     * different buttons on the dialog.
+     */
     private String id;
+    /**
+     * The submission action to take.
+     */
     @SerializedName("on_submit")
     private DialogSubmission onSubmit;
 

dialog/src/main/java/net/md_5/bungee/api/dialog/action/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Contains the different actions/buttons for a {@link net.md_5.bungee.api.dialog.Dialog}.
+ */
+package net.md_5.bungee.api.dialog.action;

dialog/src/main/java/net/md_5/bungee/api/dialog/body/DialogBody.java

@@ -1,10 +1,18 @@
 package net.md_5.bungee.api.dialog.body;
 
 import lombok.Data;
+import org.jetbrains.annotations.ApiStatus;
 
+/**
+ * Represents the body content of a {@link net.md_5.bungee.api.dialog.Dialog}.
+ */
 @Data
 public abstract class DialogBody
 {
 
+    /**
+     * The internal body type.
+     */
+    @ApiStatus.Internal
     private final String type;
 }

dialog/src/main/java/net/md_5/bungee/api/dialog/body/PlainMessageBody.java

@@ -5,13 +5,23 @@
 import lombok.ToString;
 import net.md_5.bungee.api.chat.BaseComponent;
 
+/**
+ * Represents a dialog body which consists of text constrained to a certain
+ * width.
+ */
 @Data
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
 public class PlainMessageBody extends DialogBody
 {
 
+    /**
+     * The text body.
+     */
     private BaseComponent contents;
+    /**
+     * The maximum width (default: 200).
+     */
     private int width;
 
     public PlainMessageBody(BaseComponent contents)

dialog/src/main/java/net/md_5/bungee/api/dialog/body/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * Contains the different {@link net.md_5.bungee.api.dialog.Dialog} body content
+ * types.
+ */
+package net.md_5.bungee.api.dialog.body;

dialog/src/main/java/net/md_5/bungee/api/dialog/package-info.java

@@ -1,4 +1,4 @@
 /**
- * Contains the core classes for the display of a {@link Dialog}.
+ * Contains the core classes for the display of a {@link net.md_5.bungee.api.dialog.Dialog}.
  */
 package net.md_5.bungee.api.dialog;