From 87a52f5eadbff91ff4fe2df807aa4e7bb3b29d79 Mon Sep 17 00:00:00 2001 From: Grant Miller Date: Sat, 3 Feb 2024 17:04:20 -0600 Subject: [PATCH] stm32/usart: Add doc links to buffered uarts --- embassy-stm32/src/usart/buffered.rs | 4 ++++ embassy-stm32/src/usart/ringbuffered.rs | 2 ++ 2 files changed, 6 insertions(+) diff --git a/embassy-stm32/src/usart/buffered.rs b/embassy-stm32/src/usart/buffered.rs index c78752883..c11e3382f 100644 --- a/embassy-stm32/src/usart/buffered.rs +++ b/embassy-stm32/src/usart/buffered.rs @@ -140,11 +140,15 @@ pub struct BufferedUart<'d, T: BasicInstance> { } /// Tx-only buffered UART +/// +/// Created with [BufferedUart::split] pub struct BufferedUartTx<'d, T: BasicInstance> { phantom: PhantomData<&'d mut T>, } /// Rx-only buffered UART +/// +/// Created with [BufferedUart::split] pub struct BufferedUartRx<'d, T: BasicInstance> { phantom: PhantomData<&'d mut T>, } diff --git a/embassy-stm32/src/usart/ringbuffered.rs b/embassy-stm32/src/usart/ringbuffered.rs index 4391bfef7..a0ab060a3 100644 --- a/embassy-stm32/src/usart/ringbuffered.rs +++ b/embassy-stm32/src/usart/ringbuffered.rs @@ -12,6 +12,8 @@ use crate::dma::ReadableRingBuffer; use crate::usart::{Regs, Sr}; /// Rx-only Ring-buffered UART Driver +/// +/// Created with [UartRx::into_ring_buffered] pub struct RingBufferedUartRx<'d, T: BasicInstance, RxDma: super::RxDma> { _peri: PeripheralRef<'d, T>, ring_buf: ReadableRingBuffer<'d, RxDma, u8>,