diff --git a/va416xx-hal/src/uart.rs b/va416xx-hal/src/uart.rs index 6c64675..859aa5c 100644 --- a/va416xx-hal/src/uart.rs +++ b/va416xx-hal/src/uart.rs @@ -1,5 +1,9 @@ //! # API for the UART peripheral //! +//! The core of this API are the [Uart], [UartBase], [Rx] and [Tx] structures. +//! The RX structure also has a dedicated [RxWithIrq] variant which allows reading the receiver +//! using interrupts. +//! //! ## Examples //! //! - [UART simple example](https://egit.irs.uni-stuttgart.de/rust/va416xx-rs/src/branch/main/examples/simple/examples/uart.rs)