aboutsummaryrefslogtreecommitdiff
path: root/macros/src/lib.rs
diff options
context:
space:
mode:
authorGravatar Emil Fresk <emil.fresk@gmail.com> 2020-10-05 18:25:15 +0200
committerGravatar Emil Fresk <emil.fresk@gmail.com> 2020-10-05 18:25:15 +0200
commiteec0908024d9b4127ed496b4781adc08000cc2c2 (patch)
treef128b3d91ea4ac0f171ab334d4517552a6803d01 /macros/src/lib.rs
parent9d2598dc071882a94b813ab1d9ddf49092546257 (diff)
parentf493f21359ccb3ab4643d9470f3581532f47593a (diff)
downloadrtic-eec0908024d9b4127ed496b4781adc08000cc2c2.tar.gz
rtic-eec0908024d9b4127ed496b4781adc08000cc2c2.tar.zst
rtic-eec0908024d9b4127ed496b4781adc08000cc2c2.zip
Merge branch 'master' into always_late_resources
Diffstat (limited to 'macros/src/lib.rs')
-rw-r--r--macros/src/lib.rs8
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