aboutsummaryrefslogtreecommitdiff
path: root/macros/src/codegen/init.rs
diff options
context:
space:
mode:
authorGravatar Henrik Tjäder <henrik@tjaders.com> 2023-01-22 00:26:09 +0100
committerGravatar Henrik Tjäder <henrik@tjaders.com> 2023-01-22 00:26:23 +0100
commitf6b0d18e24d49e5ecdcd18393c9c3109441a83e9 (patch)
tree1bbe38ce970844620b49ac2599fd7b21f010622f /macros/src/codegen/init.rs
parent1237f5b33b5ad61e94acb7f93255cb97bfb8ead6 (diff)
downloadrtic-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/init.rs')
-rw-r--r--macros/src/codegen/init.rs10
1 files changed, 7 insertions, 3 deletions
diff --git a/macros/src/codegen/init.rs b/macros/src/codegen/init.rs
index eaf7f612..e8a9c8b9 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 = &format!(" RTIC shared resource struct");
+ let local_resources_doc = &format!(" RTIC local resource struct");
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 = &format!(" User provided init function");
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()));
};