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/local_resources_struct.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

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

diff --git a/macros/src/codegen/local_resources_struct.rs b/macros/src/codegen/local_resources_struct.rs
index b7eae3f9..74bdbf8b 100644
--- a/macros/src/codegen/local_resources_struct.rs
+++ b/macros/src/codegen/local_resources_struct.rs
@@ -49,7 +49,9 @@ pub fn codegen(ctxt: Context, needs_lt: &mut bool, app: &App) -> (TokenStream2,
             util::declared_static_local_resource_ident(name, &task_name)
         };
 
+        let local_resource_doc = format!(" Local resource `{name}`");
         fields.push(quote!(
+            #[doc = #local_resource_doc]
             #(#cfgs)*
             pub #name: &#lt mut #ty
         ));
@@ -82,7 +84,7 @@ pub fn codegen(ctxt: Context, needs_lt: &mut bool, app: &App) -> (TokenStream2,
         }
     }
 
-    let doc = format!("Local resources `{}` has access to", ctxt.ident(app));
+    let doc = format!(" Local resources `{}` has access to", ctxt.ident(app));
     let ident = util::local_resources_ident(ctxt, app);
     let item = quote!(
         #[allow(non_snake_case)]
@@ -96,6 +98,7 @@ pub fn codegen(ctxt: Context, needs_lt: &mut bool, app: &App) -> (TokenStream2,
     let constructor = quote!(
         impl<#lt> #ident<#lt> {
             #[inline(always)]
+            #[doc(hidden)]
             pub unsafe fn new() -> Self {
                 #ident {
                     #(#values,)*
-- 
cgit v1.2.3