aboutsummaryrefslogtreecommitdiff
path: root/macros/src/lib.rs
diff options
context:
space:
mode:
authorGravatar Daniel Carosone <Daniel.Carosone@gmail.com> 2020-10-07 09:22:38 +1100
committerGravatar Daniel Carosone <Daniel.Carosone@gmail.com> 2020-10-07 09:22:38 +1100
commitf386cb63cb6d3cd6642debfb4dc1bde97b325550 (patch)
tree30b21968997f809dbbba59117db93254607fa22d /macros/src/lib.rs
parent3d6a0ea64fb2661ee1150a84425f50c18c2de9ad (diff)
parentb1e1abae29591e50ebf345a2bd249a73e564cea9 (diff)
downloadrtic-f386cb63cb6d3cd6642debfb4dc1bde97b325550.tar.gz
rtic-f386cb63cb6d3cd6642debfb4dc1bde97b325550.tar.zst
rtic-f386cb63cb6d3cd6642debfb4dc1bde97b325550.zip
Merge branch 'master'
of https://github.com/rtic-rs/cortex-m-rtic
Diffstat (limited to 'macros/src/lib.rs')
-rw-r--r--macros/src/lib.rs7
1 files changed, 3 insertions, 4 deletions
diff --git a/macros/src/lib.rs b/macros/src/lib.rs
index 7b72c7fb..e659559e 100644
--- a/macros/src/lib.rs
+++ b/macros/src/lib.rs
@@ -15,8 +15,7 @@ mod tests;
/// Attribute used to declare a RTIC application
///
-/// This attribute must be applied to a `const` item of type `()`. The `const` item is effectively
-/// used as a `mod` item: its value must be a block that contains items commonly found in modules,
+/// This attribute must be applied to a module block that contains items commonly found in modules,
/// like functions and `static` variables.
///
/// The `app` attribute has one mandatory argument:
@@ -34,9 +33,9 @@ mod tests;
/// - `monotonic = <path>`. This is a path to a zero-sized structure (e.g. `struct Foo;`) that
/// implements the `Monotonic` trait. This argument must be provided to use the `schedule` API.
///
-/// The items allowed in the block value of the `const` item are specified below:
+/// The items allowed in the module block are specified below:
///
-/// # 1. `struct Resources`
+/// # 1. `#[resources] struct <resource-name>`
///
/// This structure contains the declaration of all the resources used by the application. Each field
/// in this structure corresponds to a different resource. Each resource may optionally be given an