diff options
| author | Finomnis <finomnis@gmail.com> | 2023-11-09 00:35:47 +0100 |
|---|---|---|
| committer | Emil Fresk <emil.fresk@gmail.com> | 2023-11-10 20:49:12 +0000 |
| commit | af550483f50b3106a9be0990bd4b579e2da26e6e (patch) | |
| tree | 237bbe0a60469c9c44c92d1daaa08ace0e99e230 /rtic-monotonics/src/stm32.rs | |
| parent | 413955fb39b72a1c08c6852052b0626a175b1ca8 (diff) | |
Add documentation for imxrt; other doc fixes
Diffstat (limited to 'rtic-monotonics/src/stm32.rs')
| -rw-r--r-- | rtic-monotonics/src/stm32.rs | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/rtic-monotonics/src/stm32.rs b/rtic-monotonics/src/stm32.rs index 12845a8..2676a34 100644 --- a/rtic-monotonics/src/stm32.rs +++ b/rtic-monotonics/src/stm32.rs @@ -1,7 +1,7 @@ //! [`Monotonic`] impl for the STM32. //! //! Not all timers are available on all parts. Ensure that only available -//! timers are exposed by having the correct `stm32*` feature enabled for `rtic-monotonic`. +//! timers are exposed by having the correct `stm32*` feature enabled for `rtic-monotonics`. //! //! # Example //! @@ -137,8 +137,10 @@ macro_rules! make_timer { impl $mono_name { /// Starts the monotonic timer. + /// /// - `tim_clock_hz`: `TIMx` peripheral clock frequency. /// - `_interrupt_token`: Required for correct timer interrupt handling. + /// /// This method must be called only once. pub fn start(tim_clock_hz: u32, _interrupt_token: impl crate::InterruptToken<Self>) { _generated::$timer::enable(); |