diff --git a/macros/src/lib.rs b/macros/src/lib.rs index b33f43b68e..8ea87fa076 100644 --- a/macros/src/lib.rs +++ b/macros/src/lib.rs @@ -1,3 +1,6 @@ +//! Procedural macros for the RTFM framework + +#![deny(warnings)] #![feature(proc_macro)] #![recursion_limit = "128"] @@ -18,6 +21,8 @@ mod analyze; mod check; mod trans; +/// The `app!` macro, a macro used to specify the tasks and resources of a +/// RTFM application. #[proc_macro] pub fn app(ts: TokenStream) -> TokenStream { match run(ts) { diff --git a/src/lib.rs b/src/lib.rs index 3b677380c6..710e0d4d45 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -48,7 +48,8 @@ //! //! # Examples //! -//! In increasing grade of complexity: [examples](./examples/index.html) +//! In increasing grade of complexity, see the [examples](./examples/index.html) +//! module. #![deny(missing_docs)] #![deny(warnings)] @@ -64,10 +65,10 @@ extern crate static_ref; use core::cell::UnsafeCell; -pub use cortex_m_rtfm_macros::app; pub use cortex_m::asm::{bkpt, wfi}; pub use cortex_m::interrupt::CriticalSection; pub use cortex_m::interrupt::free as atomic; +pub use cortex_m_rtfm_macros::app; pub use static_ref::Static; use cortex_m::interrupt::Nr; #[cfg(not(armv6m))]