diff options
| author |  bors[bot] <26634292+bors[bot]@users.noreply.github.com>
| 2023-01-22 06:57:56 +0000 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-01-22 06:57:56 +0000 |
| commit | b0bda53e4e650dccb1a30718ce8dbefef6584ad0 (patch) | |
| tree | 066088a7df2514af02ee0cebe6646e41efddf963 /macros/src/codegen/module.rs | |
| parent | 86ce8919aec4623a0816b28f1adcd86db33689c8 (diff) | |
| parent | 3f74f3b8459fdd451707511954a6ea3d128aabe3 (diff) | |
| download | rtic-b0bda53e4e650dccb1a30718ce8dbefef6584ad0.tar.gz rtic-b0bda53e4e650dccb1a30718ce8dbefef6584ad0.tar.zst rtic-b0bda53e4e650dccb1a30718ce8dbefef6584ad0.zip | |
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>
Diffstat (limited to 'macros/src/codegen/module.rs')
| -rw-r--r-- | macros/src/codegen/module.rs | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/macros/src/codegen/module.rs b/macros/src/codegen/module.rs index fd8137fa..d05784d1 100644 --- a/macros/src/codegen/module.rs +++ b/macros/src/codegen/module.rs @@ -133,15 +133,16 @@ pub fn codegen( )); module_items.push(quote!( + #[doc(inline)] pub use super::#internal_monotonics_ident as Monotonics; )); } let doc = match ctxt { - Context::Idle => "Idle loop", - Context::Init => "Initialization function", - Context::HardwareTask(_) => "Hardware task", - Context::SoftwareTask(_) => "Software task", + Context::Idle => " Idle loop", + Context::Init => " Initialization function", + Context::HardwareTask(_) => " Hardware task", + Context::SoftwareTask(_) => " Software task", }; let v = Vec::new(); @@ -172,8 +173,8 @@ pub fn codegen( let internal_context_name = util::internal_task_ident(name, "Context"); items.push(quote!( - #(#cfgs)* /// Execution context + #(#cfgs)* #[allow(non_snake_case)] #[allow(non_camel_case_types)] pub struct #internal_context_name<#lt> { @@ -182,6 +183,7 @@ pub fn codegen( #(#cfgs)* impl<#lt> #internal_context_name<#lt> { + #[doc(hidden)] #[inline(always)] pub unsafe fn new(#core #priority) -> Self { #internal_context_name { @@ -192,6 +194,7 @@ pub fn codegen( )); module_items.push(quote!( + #[doc(inline)] #(#cfgs)* pub use super::#internal_context_name as Context; )); @@ -251,6 +254,7 @@ pub fn codegen( })); module_items.push(quote!( + #[doc(inline)] #(#cfgs)* pub use super::#internal_spawn_ident as spawn; )); @@ -300,6 +304,7 @@ pub fn codegen( )); } module_items.push(quote!( + #[doc(hidden)] pub mod #m { pub use super::super::#internal_spawn_after_ident as spawn_after; pub use super::super::#internal_spawn_at_ident as spawn_at; @@ -308,6 +313,7 @@ pub fn codegen( )); items.push(quote!( + #[doc(hidden)] #(#cfgs)* #[allow(non_snake_case)] #[allow(non_camel_case_types)] @@ -317,6 +323,7 @@ pub fn codegen( } impl core::fmt::Debug for #internal_spawn_handle_ident { + #[doc(hidden)] fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { f.debug_struct(#spawn_handle_string).finish() } @@ -344,6 +351,7 @@ pub fn codegen( }) } + /// Reschedule after #[inline] pub fn reschedule_after( self, @@ -352,6 +360,7 @@ pub fn codegen( self.reschedule_at(monotonics::#m::now() + duration) } + /// Reschedule at pub fn reschedule_at( self, instant: <#m as rtic::Monotonic>::Instant |