Add basic documentation support for structs

AS1100K · Jan 25, 2025 · 546d880 · 546d880
1 parent fd97cc9
commit 546d880
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/_examples/struct_examples.rs b/src/_examples/struct_examples.rs
@@ -2,6 +2,7 @@ pub struct UnitStruct;
 
 pub struct TupleStruct(i32, u64);
 
+/// This is a very basic struct
 pub struct Basic {
     pub type_: String,
     pub r#type: String,

diff --git a/src/generators/struct_gen.rs b/src/generators/struct_gen.rs
@@ -24,6 +24,10 @@ impl Generator for StructGenerator {
             impls,
         }) = &item.inner
         {
+            let mut docs = match &item.docs {
+                Some(docs) => docs.clone(),
+                None => String::new(),
+            };
             let mut fields_section = String::new();
             let mut syntax = String::from("```rust\n");
             syntax.push_str(&VisibilityGenerator::generate_visibility(&item.visibility));
@@ -129,6 +133,10 @@ impl Generator for StructGenerator {
                         title: String::new(),
                         content: syntax,
                     },
+                    InnerModuleContent {
+                        title: String::new(),
+                        content: docs,
+                    },
                     InnerModuleContent {
                         title: String::from("Fields"),
                         content: fields_section,