fixes #144 & #116

macros/Cargo.toml

@@ -10,14 +10,14 @@ documentation = "https://docs.rs/specta/latest/specta"
 keywords = ["async", "specta", "rspc", "typescript", "typesafe"]
 categories = ["web-programming", "asynchronous"]
 
+[lib]
+proc-macro = true
+
 [features]
 serde = []
 functions = []
 export = []
 
-[lib]
-proc-macro = true
-
 [dependencies]
 Inflector = { version = "0.11.4", default-features = false }
 itertools = "0.10.5"

macros/src/data_type_from/mod.rs

@@ -54,6 +54,7 @@ pub fn derive(input: proc_macro::TokenStream) -> syn::Result<proc_macro::TokenSt
                         #skip,
                         false,
                         false,
+                        std::borrow::Cow::Borrowed(""),
                         t.#ident.into(),
                     )))
                 });

macros/src/type/attr/container.rs

@@ -13,7 +13,7 @@ pub struct ContainerAttr {
     pub inline: bool,
     pub remote: Option<TokenStream>,
     pub export: Option<bool>,
-    pub doc: Vec<String>,
+    pub doc: String,
     pub deprecated: Option<String>,
 
     // Struct ony (we pass it anyway so enums get nice errors)
@@ -45,7 +45,11 @@ impl_parse! {
         "export" => out.export = out.export.take().or(Some(attr.parse_bool().unwrap_or(true))),
         "doc" => {
             if attr.key == "doc" {
-                out.doc.push(attr.parse_string()?);
+                if !out.doc.is_empty() {
+                    out.doc.push_str("\n");
+                }
+
+                out.doc.push_str(&attr.parse_string()?);
             }
         },
         // TODO: Finish implementing by supporting the official `#[deprecated]` attribute: https://github.com/oscartbeaumont/specta/issues/32

macros/src/type/attr/field.rs

@@ -12,6 +12,7 @@ pub struct FieldAttr {
     pub skip: bool,
     pub optional: bool,
     pub flatten: bool,
+    pub doc: String,
 }
 
 impl_parse! {
@@ -41,7 +42,16 @@ impl_parse! {
         // Specta only attribute
         "optional" => out.optional = attr.parse_bool().unwrap_or(true),
         "default" => out.optional = attr.parse_bool().unwrap_or(true),
-        "flatten" => out.flatten = attr.parse_bool().unwrap_or(true)
+        "flatten" => out.flatten = attr.parse_bool().unwrap_or(true),
+        "doc" => {
+            if attr.key == "doc" {
+                if !out.doc.is_empty() {
+                    out.doc.push_str("\n");
+                }
+
+                out.doc.push_str(&attr.parse_string()?);
+            }
+        },
     }
 }
 
@@ -51,6 +61,7 @@ impl FieldAttr {
         Self::try_from_attrs("specta", attrs, &mut result)?;
         #[cfg(feature = "serde")]
         Self::try_from_attrs("serde", attrs, &mut result)?;
+        Self::try_from_attrs("doc", attrs, &mut result)?;
         Ok(result)
     }
 }

macros/src/type/attr/variant.rs

@@ -10,6 +10,7 @@ pub struct VariantAttr {
     pub rename: Option<TokenStream>,
     pub skip: bool,
     pub inline: bool,
+    pub doc: String,
 }
 
 impl_parse! {
@@ -20,6 +21,15 @@ impl_parse! {
         "skip_serializing" => out.skip = true,
         "skip_deserializing" => out.skip = true,
         "inline" => out.inline = attr.parse_bool().unwrap_or(true),
+        "doc" => {
+            if attr.key == "doc" {
+                if !out.doc.is_empty() {
+                    out.doc.push_str("\n");
+                }
+
+                out.doc.push_str(&attr.parse_string()?);
+            }
+        },
     }
 }
 
@@ -29,6 +39,7 @@ impl VariantAttr {
         Self::try_from_attrs("specta", attrs, &mut result)?;
         #[cfg(feature = "serde")]
         Self::try_from_attrs("serde", attrs, &mut result)?;
+        Self::try_from_attrs("doc", attrs, &mut result)?;
         Ok(result)
     }
 }

macros/src/type/enum.rs

@@ -102,6 +102,7 @@ pub fn parse_enum(
                                 let skip = field_attrs.skip;
                                 let optional = field_attrs.optional;
                                 let flatten = field_attrs.flatten;
+                                let doc = field_attrs.doc;
 
                                 let generic_vars = construct_datatype(
                                     format_ident!("gen"),
@@ -115,6 +116,7 @@ pub fn parse_enum(
                                     #skip,
                                     #optional,
                                     #flatten,
+                                    #doc.into(),
                                     {
                                         #generic_vars
 
@@ -159,11 +161,13 @@ pub fn parse_enum(
                             let skip = field_attrs.skip;
                             let optional = field_attrs.optional;
                             let flatten = field_attrs.flatten;
+                            let doc = field_attrs.doc;
 
                             Ok(quote!((#field_name.into(), #crate_ref::internal::construct::field(
                                 #skip,
                                 #optional,
                                 #flatten,
+                                #doc.into(),
                                 {
                                     #generic_vars
 
@@ -178,7 +182,8 @@ pub fn parse_enum(
                 };
 
                 let skip = attrs.skip;
-                Ok(quote!((#variant_name_str.into(), #crate_ref::internal::construct::enum_variant(#skip, #inner))))
+                let doc = attrs.doc;
+                Ok(quote!((#variant_name_str.into(), #crate_ref::internal::construct::enum_variant(#skip, #doc.into(), #inner))))
             })
             .collect::<syn::Result<Vec<_>>>()?;
 

macros/src/type/mod.rs

@@ -109,10 +109,7 @@ pub fn derive(input: proc_macro::TokenStream) -> syn::Result<proc_macro::TokenSt
         }
     });
 
-    let comments = {
-        let comments = &container_attrs.doc;
-        quote!(vec![#(#comments.into()),*])
-    };
+    let comments = &container_attrs.doc;
     let should_export = match container_attrs.export {
         Some(export) => quote!(Some(#export)),
         None => quote!(None),
@@ -153,7 +150,7 @@ pub fn derive(input: proc_macro::TokenStream) -> syn::Result<proc_macro::TokenSt
                 fn named_data_type(opts: #crate_ref::DefOpts, generics: &[#crate_ref::DataType]) -> #crate_ref::NamedDataType {
                     #crate_ref::internal::construct::named_data_type(
                         #name.into(),
-                        #comments,
+                        #comments.into(),
                         #deprecated,
                         SID,
                         IMPL_LOCATION,

macros/src/type/struct.rs

@@ -129,6 +129,7 @@ pub fn parse_struct(
                     let optional = field_attrs.optional;
                     let flatten = field_attrs.flatten;
                     let skip = field_attrs.skip;
+                    let doc = field_attrs.doc;
 
                     let parent_inline = container_attrs
                         .inline
@@ -164,6 +165,7 @@ pub fn parse_struct(
                         #skip,
                         #optional,
                         #flatten,
+                        #doc.into(),
                         {
                             #ty
                         }
@@ -197,10 +199,11 @@ pub fn parse_struct(
                         let optional = field_attrs.optional;
                         let flatten = field_attrs.flatten;
                         let skip = field_attrs.skip;
+                        let doc = field_attrs.doc;
                         Ok(quote!({
                             #generic_vars
 
-                            #crate_ref::internal::construct::field(#skip, #optional, #flatten, gen)
+                            #crate_ref::internal::construct::field(#skip, #optional, #flatten, #doc.into(), gen)
                         }))
                     })
                     .collect::<syn::Result<Vec<TokenStream>>>()?;

src/datatype/enum.rs

@@ -28,7 +28,7 @@ impl EnumType {
     pub fn to_named(self, name: impl Into<Cow<'static, str>>) -> NamedDataType {
         NamedDataType {
             name: name.into(),
-            comments: vec![],
+            docs: Cow::Borrowed(""),
             deprecated: None,
             ext: None,
             inner: DataType::Enum(self),
@@ -79,6 +79,8 @@ pub struct EnumVariant {
     /// You might think, well why not apply this in the macro and just not emit the variant?
     /// Well in Serde `A(String)` and `A(#[serde(skip)] (), String)` export as different Typescript types so the exporter needs runtime knowledge of this.
     pub(crate) skip: bool,
+    /// Documentation comments for the field.
+    pub(crate) docs: Cow<'static, str>,
     /// The type of the variant.
     pub(crate) inner: EnumVariants,
 }
@@ -88,6 +90,10 @@ impl EnumVariant {
         self.skip
     }
 
+    pub fn docs(&self) -> &Cow<'static, str> {
+        &self.docs
+    }
+
     pub fn inner(&self) -> &EnumVariants {
         &self.inner
     }

src/datatype/fields.rs

@@ -15,10 +15,16 @@ pub struct Field {
     pub(crate) optional: bool,
     /// Did the user apply a `#[serde(flatten)]` or `#[specta(flatten)]` attribute.
     pub(crate) flatten: bool,
+    /// Documentation comments for the field.
+    pub(crate) docs: Cow<'static, str>,
     pub(crate) ty: DataType,
 }
 
 impl Field {
+    pub fn skip(&self) -> bool {
+        self.skip
+    }
+
     pub fn optional(&self) -> bool {
         self.optional
     }
@@ -27,6 +33,10 @@ impl Field {
         self.flatten
     }
 
+    pub fn docs(&self) -> &Cow<'static, str> {
+        &self.docs
+    }
+
     pub fn ty(&self) -> &DataType {
         &self.ty
     }

src/datatype/mod.rs

@@ -75,7 +75,7 @@ impl DataType {
     pub fn to_named(self, name: impl Into<Cow<'static, str>>) -> NamedDataType {
         NamedDataType {
             name: name.into(),
-            comments: vec![],
+            docs: Cow::Borrowed(""),
             deprecated: None,
             ext: None,
             inner: self,
@@ -163,11 +163,13 @@ impl<T: Into<DataType> + 'static> From<Vec<T>> for DataType {
                         },
                         EnumVariant {
                             skip: false,
+                            docs: Cow::Borrowed(""),
                             inner: EnumVariants::Unnamed(UnnamedFields {
                                 fields: vec![Field {
                                     skip: false,
                                     optional: false,
                                     flatten: false,
+                                    docs: Cow::Borrowed(""),
                                     ty,
                                 }],
                             }),

src/datatype/named.rs

@@ -35,7 +35,7 @@ pub struct NamedDataType {
     /// The name of the type
     pub(crate) name: Cow<'static, str>,
     /// Rust documentation comments on the type
-    pub(crate) comments: Vec<Cow<'static, str>>,
+    pub(crate) docs: Cow<'static, str>,
     /// The Rust deprecated comment if the type is deprecated.
     pub(crate) deprecated: Option<Cow<'static, str>>,
     /// Extra information that comes from a real Rust type (using the `Type` macro).
@@ -51,8 +51,8 @@ impl NamedDataType {
         &self.name
     }
 
-    pub fn comments(&self) -> &Vec<Cow<'static, str>> {
-        &self.comments
+    pub fn docs(&self) -> &Cow<'static, str> {
+        &self.docs
     }
 
     pub fn deprecated(&self) -> Option<&Cow<'static, str>> {

src/datatype/struct.rs

@@ -37,7 +37,7 @@ impl StructType {
     pub fn to_named(self, name: impl Into<Cow<'static, str>>) -> NamedDataType {
         NamedDataType {
             name: name.into(),
-            comments: vec![],
+            docs: Cow::Borrowed(""),
             deprecated: None,
             ext: None,
             inner: DataType::Struct(self),

src/datatype/tuple.rs

@@ -23,7 +23,7 @@ impl TupleType {
     pub fn to_named(self, name: impl Into<Cow<'static, str>>) -> NamedDataType {
         NamedDataType {
             name: name.into(),
-            comments: vec![],
+            docs: Cow::Borrowed(""),
             deprecated: None,
             ext: None,
             inner: DataType::Tuple(self),

src/internal.rs

@@ -18,11 +18,18 @@ pub mod construct {
 
     use crate::{datatype::*, ImplLocation, SpectaID};
 
-    pub const fn field(skip: bool, optional: bool, flatten: bool, ty: DataType) -> Field {
+    pub const fn field(
+        skip: bool,
+        optional: bool,
+        flatten: bool,
+        docs: Cow<'static, str>,
+        ty: DataType,
+    ) -> Field {
         Field {
             skip,
             optional,
             flatten,
+            docs,
             ty,
         }
     }
@@ -68,8 +75,12 @@ pub mod construct {
         }
     }
 
-    pub const fn enum_variant(skip: bool, inner: EnumVariants) -> EnumVariant {
-        EnumVariant { skip, inner }
+    pub const fn enum_variant(
+        skip: bool,
+        docs: Cow<'static, str>,
+        inner: EnumVariants,
+    ) -> EnumVariant {
+        EnumVariant { skip, docs, inner }
     }
 
     pub const fn enum_variant_unit() -> EnumVariants {
@@ -89,7 +100,7 @@ pub mod construct {
 
     pub const fn named_data_type(
         name: Cow<'static, str>,
-        comments: Vec<Cow<'static, str>>,
+        docs: Cow<'static, str>,
         deprecated: Option<Cow<'static, str>>,
         sid: SpectaID,
         impl_location: ImplLocation,
@@ -98,7 +109,7 @@ pub mod construct {
     ) -> NamedDataType {
         NamedDataType {
             name,
-            comments,
+            docs,
             deprecated,
             ext: Some(NamedDataTypeExt {
                 sid,