Merge branch 'master' of https://github.com/linclelinkpart5/strum into linclelinkpart5-master-2

Author: Peter Glotfelty

strum_macros/src/helpers/metadata.rs

@@ -26,6 +26,7 @@ pub mod kw {
     custom_keyword!(derive);
     custom_keyword!(name);
     custom_keyword!(vis);
+    custom_keyword!(doc);
 
     // variant metadata
     custom_keyword!(message);
@@ -115,6 +116,7 @@ pub enum EnumDiscriminantsMeta {
     Derive { _kw: kw::derive, paths: Vec<Path> },
     Name { kw: kw::name, name: Ident },
     Vis { kw: kw::vis, vis: Visibility },
+    Doc { _kw: kw::doc, doc: LitStr },
     Other { path: Path, nested: TokenStream },
 }
 
@@ -141,6 +143,11 @@ impl Parse for EnumDiscriminantsMeta {
             parenthesized!(content in input);
             let vis = content.parse()?;
             Ok(EnumDiscriminantsMeta::Vis { kw, vis })
+        } else if input.peek(kw::doc) {
+            let _kw = input.parse()?;
+            input.parse::<Token![=]>()?;
+            let doc = input.parse()?;
+            Ok(EnumDiscriminantsMeta::Doc { _kw, doc })
         } else {
             let path = input.parse()?;
             let content;

strum_macros/src/helpers/type_props.rs

@@ -26,6 +26,7 @@ pub struct StrumTypeProperties {
     pub prefix: Option<LitStr>,
     pub enum_repr: Option<TokenStream>,
     pub const_into_str: bool,
+    pub discriminant_docs: Vec<LitStr>,
 }
 
 impl HasTypeProperties for DeriveInput {
@@ -139,6 +140,9 @@ impl HasTypeProperties for DeriveInput {
                     vis_kw = Some(kw);
                     output.discriminant_vis = Some(vis);
                 }
+                EnumDiscriminantsMeta::Doc { doc, .. } => {
+                    output.discriminant_docs.push(doc);
+                }
                 EnumDiscriminantsMeta::Other { path, nested } => {
                     output.discriminant_others.push(quote! { #path(#nested) });
                 }

strum_macros/src/lib.rs

@@ -853,6 +853,7 @@ pub fn enum_properties(input: proc_macro::TokenStream) -> proc_macro::TokenStrea
 /// # #[allow(dead_code)]
 /// #[derive(Debug, EnumDiscriminants)]
 /// #[strum_discriminants(derive(EnumString, EnumMessage))]
+/// #[strum_discriminants(doc = "This is the docstring on the generated type.")]
 /// enum MyEnum {
 ///     #[strum_discriminants(strum(message = "Variant zero"))]
 ///     Variant0(NonDefault),

strum_macros/src/macros/enum_discriminants.rs

@@ -30,6 +30,13 @@ pub fn enum_discriminants_inner(ast: &DeriveInput) -> syn::Result<TokenStream> {
         #[derive(Clone, Copy, Debug, PartialEq, Eq, #(#derives),*)]
     };
 
+    // Create #[doc] attrs for new generated type.
+    let docs = type_properties.discriminant_docs;
+
+    let docs = quote! {
+        #(#[doc = #docs])*
+    };
+
     // Work out the name
     let default_name = syn::Ident::new(&format!("{}Discriminants", name), Span::call_site());
 
@@ -181,7 +188,7 @@ pub fn enum_discriminants_inner(ast: &DeriveInput) -> syn::Result<TokenStream> {
     };
 
     Ok(quote! {
-        /// Auto-generated discriminant enum variants
+        #docs
         #derives
         #repr
         #(#[ #pass_though_attributes ])*