add comments for form fields

bedrock-crustaceans · Oct 3, 2024 · b151c61 · b151c61
1 parent 4f7292e
commit b151c61
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/crates/form/src/forms/custom.rs b/crates/form/src/forms/custom.rs
@@ -7,7 +7,9 @@ use serde::{Deserialize, Serialize};
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(deny_unknown_fields)]
 pub struct CustomForm {
+    /// Refers to the title.
     pub title: String,
+    /// All elements in the [`CustomForm`](CustomForm). Sequence is maintained.
     #[serde(rename = "content")]
     pub elements: Vec<Element>,
 }
diff --git a/crates/form/src/forms/modal.rs b/crates/form/src/forms/modal.rs
@@ -9,9 +9,13 @@ use serde::{Deserialize, Serialize};
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(deny_unknown_fields)]
 pub struct ModalForm {
+    /// Refers to the title.
     pub title: String,
+    /// Refers to the body.
     #[serde(rename = "content")]
     pub body: String,
+    /// Refers to the first displayed button.
     pub button1: Button,
+    /// Refers to the second displayed button.
     pub button2: Button,
 }
diff --git a/crates/form/src/forms/simple.rs b/crates/form/src/forms/simple.rs
@@ -7,8 +7,11 @@ use serde::{Deserialize, Serialize};
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(deny_unknown_fields)]
 pub struct SimpleForm {
+    /// Refers to the title.
     pub title: String,
+    /// Refers to the body.
     #[serde(rename = "content")]
     pub body: String,
+    /// Refers to all available buttons. Sequence is maintained.
     pub buttons: Vec<Button>,
 }