diff options
| author |  bors[bot] <26634292+bors[bot]@users.noreply.github.com>
| 2023-01-22 06:57:56 +0000 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-01-22 06:57:56 +0000 |
| commit | b0bda53e4e650dccb1a30718ce8dbefef6584ad0 (patch) | |
| tree | 066088a7df2514af02ee0cebe6646e41efddf963 /macros/src/codegen/idle.rs | |
| parent | 86ce8919aec4623a0816b28f1adcd86db33689c8 (diff) | |
| parent | 3f74f3b8459fdd451707511954a6ea3d128aabe3 (diff) | |
| download | rtic-b0bda53e4e650dccb1a30718ce8dbefef6584ad0.tar.gz rtic-b0bda53e4e650dccb1a30718ce8dbefef6584ad0.tar.zst rtic-b0bda53e4e650dccb1a30718ce8dbefef6584ad0.zip | |
Merge #689
689: Missing docs: Improve #[doc] generation r=korken89 a=AfoHT
Improve RTIC doc handling
Enable use of
```
#![deny(missing_docs)]
```
and makes the cargo doc output more useful
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
Diffstat (limited to 'macros/src/codegen/idle.rs')
| -rw-r--r-- | macros/src/codegen/idle.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/macros/src/codegen/idle.rs b/macros/src/codegen/idle.rs index 83b85d7b..77a7f9fe 100644 --- a/macros/src/codegen/idle.rs +++ b/macros/src/codegen/idle.rs @@ -59,12 +59,14 @@ pub fn codegen( analysis, extra, )); + let idle_doc = " User provided idle function".to_string(); let attrs = &idle.attrs; let context = &idle.context; let stmts = &idle.stmts; let user_idle = Some(quote!( #(#attrs)* + #[doc = #idle_doc] #[allow(non_snake_case)] fn #name(#context: #name::Context) -> ! { use rtic::Mutex as _; |