clean-macro-docs 1.0.0

Hide internal rules when documenting `macro_rules!` macros.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

mod expected_output {
    use crate::clean_docs_impl;
    use quote::quote;
    use syn::parse::Parser;
    use syn::punctuated::Punctuated;
    use syn::{parse2, NestedMeta, Token};

    macro_rules! make_test {
        (
            [$name:ident]

            input {
                #[clean_docs($($args:tt)*)]
                $($mac:tt)*
            }

            expect {
                $($expected:tt)*
            }
        ) => {
            #[test]
            fn $name() {
                let args = Punctuated::<NestedMeta, Token![,]>::parse_terminated
                    .parse2(quote! {
                        $($args)*
                    })
                    .unwrap()
                    .into_iter()
                    .collect();

                let input = parse2(quote! {
                    $($mac)*
                })
                .unwrap();

                let output = clean_docs_impl(args, input);

                let expected = quote! {
                    $($expected)*
                };

                assert_eq!(output.to_string(), expected.to_string());
            }
        };
    }
    
    make_test! { [simple]
        input {
            #[clean_docs(always = true)]
            #[macro_export]
            macro_rules! simple_macro {
                (@impl $e:expr) => {
                    format!("{}", $e)
                };
                ($e:expr) => {
                    simple_macro!(@impl $e)
                };
            }
        }

        expect {
            #[macro_export]
            macro_rules! simple_macro {
                ($e:expr) => {
                    $crate::__simple_macro!(@impl $e)
                }
            }

            #[doc(hidden)]
            #[macro_export]
            macro_rules! __simple_macro {
                (@impl $e:expr) => {
                    format!("{}", $e)
                }
            }

            #[allow(unused_macros)]
            macro_rules! simple_macro {
                (@impl $e:expr) => {
                    format!("{}", $e)
                };
                ($e:expr) => {
                    simple_macro!(@impl $e)
                };
            }
        }
    }
}