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>

1 files changed, 7 insertions, 3 deletions

diff --git a/macros/src/codegen/init.rs b/macros/src/codegen/init.rs
index eaf7f612..34f86f27 100644
--- a/macros/src/codegen/init.rs
+++ b/macros/src/codegen/init.rs
@@ -65,22 +65,27 @@ pub fn codegen(app: &App, analysis: &Analysis, extra: &Extra) -> CodegenResult {
             )
         })
         .collect();
+
+    let shared_resources_doc = " RTIC shared resource struct".to_string();
+    let local_resources_doc = " RTIC local resource struct".to_string();
     root_init.push(quote! {
+        #[doc = #shared_resources_doc]
         struct #shared {
             #(#shared_resources)*
         }
 
+        #[doc = #local_resources_doc]
         struct #local {
             #(#local_resources)*
         }
     });
 
-    // let locals_pat = locals_pat.iter();
-
     let user_init_return = quote! {#shared, #local, #name::Monotonics};
+    let user_init_doc = " User provided init function".to_string();
 
     let user_init = quote!(
         #(#attrs)*
+        #[doc = #user_init_doc]
         #[inline(always)]
         #[allow(non_snake_case)]
         fn #name(#context: #name::Context) -> (#user_init_return) {
@@ -100,7 +105,6 @@ pub fn codegen(app: &App, analysis: &Analysis, extra: &Extra) -> CodegenResult {
         mod_app = Some(constructor);
     }
 
-    // let locals_new = locals_new.iter();
     let call_init = quote! {
         let (shared_resources, local_resources, mut monotonics) = #name(#name::Context::new(core.into()));
     };