diff options
author | 2020-10-05 08:40:19 +0000 | |
---|---|---|
committer | 2020-10-05 08:40:19 +0000 | |
commit | dbf9a7f2983fb00aee130305fec0019c12eaef76 (patch) | |
tree | 0422a3712af398436cebfa9f8e6ac422de65dde1 /macros/src/lib.rs | |
parent | 04d415c3c6cce7f763decdf02104d827f2e4de7c (diff) | |
parent | 95503b6bdff3f392450d1972b0c499b79a9c2092 (diff) | |
download | rtic-dbf9a7f2983fb00aee130305fec0019c12eaef76.tar.gz rtic-dbf9a7f2983fb00aee130305fec0019c12eaef76.tar.zst rtic-dbf9a7f2983fb00aee130305fec0019c12eaef76.zip |
Merge #368
368: Mod over const r=korken89 a=AfoHT
Related [RFC](https://github.com/rtic-rs/rfcs/pull/34)
Dependent on [rtic-syntax-PR30](https://github.com/rtic-rs/rtic-syntax/pull/30)
~~Currently using my own dev-branch~~
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
Diffstat (limited to 'macros/src/lib.rs')
-rw-r--r-- | macros/src/lib.rs | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/macros/src/lib.rs b/macros/src/lib.rs index 7b72c7fb..94e7eec6 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,10 @@ 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 |