clean-macro-docs 1.0.1

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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

Hide Internal Rules in `macro_rules!` Docs
==========================================

When generating docs for `macro_rules!` macros, `rustdoc` will include every
rule, including internal rules that are only supposed to be called from within
your macro. The `clean_docs` attribute will hide your internal rules from
`rustdoc`.

## Example:
```rust
#[macro_export]
macro_rules! messy {
    (@impl $e:expr) => {
        format!("{}", $e)
    };
    ($e:expr) => {
        messy!(@impl $e)
    };
}

#[clean_docs]
#[macro_export]
macro_rules! clean {
    (@impl $e:expr) => {
        format!("{}", $e)
    };
    ($e:expr) => {
        clean!(@impl $e)
    };
}
```

would be documented as
```rust
macro_rules! messy {
    (@impl $e:expr) => { ... };
    ($e:expr) => { ... };
}

macro_rules! clean {
    ($e:expr) => { ... };
}
```

## How does it work?
The macro above is transformed into
```rust
#[macro_export]
macro_rules! clean {
    ($e:expr) => {
        $crate::__clean!(@impl $e)
    };
}

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

macro_rules! clean {
    (@impl $e:expr) => {
        format!("{}", $e)
    };
    ($e:expr) => {
        clean!(@impl $e)
    };
}
```

The last, non-`macro_export` macro is there becuase Rust doesn't allow
macro-expanded macro to be invoked by absolute path (i.e. `$crate::__mac`).

The solution is to shadow the `macro_export`ed macro with a local version
that doesn't use absolute paths.

By default this transformation only happens when `rustdoc` is building the
documentation for your macro, so `clean_docs` shouldn't affect your normal
compilation times (see [`always`](#always)).

## Arguments
You can use these optional arguments to configure `clean_macro`.

```rust
#[clean_docs(impl = "#internal", internal = "__internal_mac", always = true)]
```

### `impl`
A string representing the "flag" at the begining of an internal rule. Defaults to `"@"`.

```rust
#[clean_docs(impl = "#internal")]
#[macro_export]
macro_rules! mac {
    (#internal $e:expr) => {
        format!("{}", $e)
    };
    ($e:expr) => {
        mac!(#internal $e)
    };
}
```

### `internal`
A string representing the identifier to use for the internal version of your macro.
By default `clean_docs` prepends `__` (two underscores) to the main macro's identifier.

```rust
#[clean_docs(internal = "__internal_mac")]
#[macro_export]
macro_rules! mac {
    (@impl $e:expr) => {
        format!("{}", $e)
    };
    ($e:expr) => {
        mac!(@impl $e)
    };
}
```

### `always`
A boolean that tells `clean_docs` whether it should transform the macro
even when not building documentation. This is mainly used for testing
purposes. Defaults to `false`.

```rust
#[clean_docs(always = true)]
#[macro_export]
macro_rules! mac {
    (@impl $e:expr) => {
        format!("{}", $e)
    };
    ($e:expr) => {
        mac!(@impl $e)
    };
}
```