Fixing docstring format

Aleph-Alpha · May 5, 2022 · 08ec9c5 · 08ec9c5
1 parent 1003e82
commit 08ec9c5
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/macros/src/types/enum.rs b/macros/src/types/enum.rs
@@ -100,7 +100,7 @@ fn format_variant(
     let inline_type = variant_type.inline;
 
     let doc = match doc_string {
-        Some(s) => format!("/** {} */ ", s),
+        Some(s) => format!("\n/**\n* {}\n*/\n", s),
         None => "".to_string(),
     };
 

diff --git a/macros/src/types/named.rs b/macros/src/types/named.rs
@@ -110,7 +110,7 @@ fn format_field(
     };
 
     let doc_string = match doc_string {
-        Some(doc) => format!("/** {} */ ", doc),
+        Some(s) => format!("\n/**\n* {}\n*/\n", s),
         None => "".to_string(),
     };
 

diff --git a/macros/src/types/newtype.rs b/macros/src/types/newtype.rs
@@ -53,7 +53,7 @@ pub(crate) fn newtype(
     };
 
     let doc = match doc_string {
-        Some(s) => format!("/** {} */ ", s),
+        Some(s) => format!("\n/**\n* {}\n*/\n", s),
         None => "".to_string(),
     };
 

diff --git a/ts-rs/tests/doc_string.rs b/ts-rs/tests/doc_string.rs
@@ -12,5 +12,5 @@ struct DocString {
 
 #[test]
 fn test() {
-    assert_eq!(DocString::inline(), "{ /** @mydoc */ a: number, /** @mydoc2 */ b: string, }");
+    assert_eq!(DocString::inline(), "{ \n/**\n* @mydoc\n*/\na: number, \n/**\n* @mydoc2\n*/\nb: string, }");
 }