diff options
| author |  Henrik Tjäder <henrik@tjaders.com>
| 2023-01-22 00:26:09 +0100 |
|---|---|---|
| committer | Henrik Tjäder <henrik@tjaders.com>
| 2023-01-22 00:26:23 +0100 |
| commit | f6b0d18e24d49e5ecdcd18393c9c3109441a83e9 (patch) | |
| tree | 1bbe38ce970844620b49ac2599fd7b21f010622f /macros/src/codegen/hardware_tasks.rs | |
| parent | 1237f5b33b5ad61e94acb7f93255cb97bfb8ead6 (diff) | |
| download | rtic-f6b0d18e24d49e5ecdcd18393c9c3109441a83e9.tar.gz rtic-f6b0d18e24d49e5ecdcd18393c9c3109441a83e9.tar.zst rtic-f6b0d18e24d49e5ecdcd18393c9c3109441a83e9.zip | |
Improve RTIC doc handling
Enable use of
```
#![deny(missing_docs)]
```
Diffstat (limited to 'macros/src/codegen/hardware_tasks.rs')
| -rw-r--r-- | macros/src/codegen/hardware_tasks.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/macros/src/codegen/hardware_tasks.rs b/macros/src/codegen/hardware_tasks.rs index f75c71d4..780cc7e3 100644 --- a/macros/src/codegen/hardware_tasks.rs +++ b/macros/src/codegen/hardware_tasks.rs @@ -33,10 +33,12 @@ pub fn codegen( let priority = task.args.priority; let cfgs = &task.cfgs; let attrs = &task.attrs; + let user_hardware_task_isr_doc = &format!(" User HW task ISR trampoline for {name}"); mod_app.push(quote!( #[allow(non_snake_case)] #[no_mangle] + #[doc = #user_hardware_task_isr_doc] #(#attrs)* #(#cfgs)* unsafe fn #symbol() { @@ -88,11 +90,13 @@ pub fn codegen( extra, )); + let user_hardware_task_doc = &format!(" User HW task: {name}"); if !task.is_extern { let attrs = &task.attrs; let context = &task.context; let stmts = &task.stmts; user_tasks.push(quote!( + #[doc = #user_hardware_task_doc] #(#attrs)* #[allow(non_snake_case)] fn #name(#context: #name::Context) { |