doc tweaks

This commit is contained in:
Jorge Aparicio 2017-07-20 23:14:41 -05:00
parent 0788a15a39
commit c64e7decfe
2 changed files with 8 additions and 2 deletions

View file

@ -1,3 +1,6 @@
//! Procedural macros for the RTFM framework
#![deny(warnings)]
#![feature(proc_macro)] #![feature(proc_macro)]
#![recursion_limit = "128"] #![recursion_limit = "128"]
@ -18,6 +21,8 @@ mod analyze;
mod check; mod check;
mod trans; mod trans;
/// The `app!` macro, a macro used to specify the tasks and resources of a
/// RTFM application.
#[proc_macro] #[proc_macro]
pub fn app(ts: TokenStream) -> TokenStream { pub fn app(ts: TokenStream) -> TokenStream {
match run(ts) { match run(ts) {

View file

@ -48,7 +48,8 @@
//! //!
//! # Examples //! # 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(missing_docs)]
#![deny(warnings)] #![deny(warnings)]
@ -64,10 +65,10 @@ extern crate static_ref;
use core::cell::UnsafeCell; use core::cell::UnsafeCell;
pub use cortex_m_rtfm_macros::app;
pub use cortex_m::asm::{bkpt, wfi}; pub use cortex_m::asm::{bkpt, wfi};
pub use cortex_m::interrupt::CriticalSection; pub use cortex_m::interrupt::CriticalSection;
pub use cortex_m::interrupt::free as atomic; pub use cortex_m::interrupt::free as atomic;
pub use cortex_m_rtfm_macros::app;
pub use static_ref::Static; pub use static_ref::Static;
use cortex_m::interrupt::Nr; use cortex_m::interrupt::Nr;
#[cfg(not(armv6m))] #[cfg(not(armv6m))]