From f6b0d18e24d49e5ecdcd18393c9c3109441a83e9 Mon Sep 17 00:00:00 2001
From: Henrik Tjäder <henrik@tjaders.com>
Date: Sun, 22 Jan 2023 00:26:09 +0100
Subject: Improve RTIC doc handling

Enable use of

```
 #![deny(missing_docs)]
```
---
 macros/src/codegen/hardware_tasks.rs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'macros/src/codegen/hardware_tasks.rs')

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) {
-- 
cgit v1.2.3