From af550483f50b3106a9be0990bd4b579e2da26e6e Mon Sep 17 00:00:00 2001 From: Finomnis Date: Thu, 9 Nov 2023 00:35:47 +0100 Subject: Add documentation for imxrt; other doc fixes --- rtic-monotonics/src/stm32.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'rtic-monotonics/src/stm32.rs') 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) { _generated::$timer::enable(); -- cgit v1.2.3