Skip to content

Commit

Permalink
doc(macros): document process and channel constants
Browse files Browse the repository at this point in the history
  • Loading branch information
sevenautumns authored and dadada committed Nov 5, 2024
1 parent f93034d commit bcac08e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions macros/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,17 @@ mod partition;
/// - The identifier of the functions can be anything
/// - The identifier of the `Context` can be anything
///
/// ## Constants
///
/// Inside the module of each process (named after the process in snake_case) there are some convenience constants.
///
/// - NAME: `a653rs::prelude::Name`
/// - TIME_CAPACITY: `a653rs::prelude::SystemTime`
/// - PERIOD: `a653rs::prelude::SystemTime`
/// - STACK_SIZE: `a653rs::prelude::StackSize`
/// - BASE_PRIORITY: `a653rs::prelude::Priority`
/// - DEADLINE: `a653rs::prelude::Deadline`
///
/// ## Example
/// ```no_run
/// # use a653rs::prelude::PartitionExt;
Expand Down Expand Up @@ -302,6 +313,16 @@ mod partition;
///
/// - The identifier of the struct can be anything
///
/// ## Constants
///
/// Inside the module of each channel (named after the channel in snake_case) there are some convenience constants.
///
/// - NAME: `a653rs::prelude::Name`
/// - MSG_SIZE: `a653rs::prelude::MessageSize`
/// - (QueuingPorts only) NB_MSGS: `a653rs::prelude::MessageRange`
/// - (QueuingPorts only) DISCIPLINE: `a653rs::prelude::QueuingDiscipline`
/// - (SamplingPort in only) REFRESH_PERIOD: `core::time::Duration`
///
/// ## Example
/// ```no_run
/// # use a653rs::prelude::PartitionExt;
Expand Down

0 comments on commit bcac08e

Please sign in to comment.