Skip to content

Commit 102d111

Browse files
committed
doc improvements
1 parent 8cdee8b commit 102d111

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

va108xx-hal/src/uart/mod.rs

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
//! # API for the UART peripheral
22
//!
3+
//! The core of this API are the [Uart], [UartBase], [Rx] and [Tx] structures.
4+
//! The RX structure also has a dedicated [RxWithInterrupt] variant which allows reading the receiver
5+
//! using interrupts.
6+
//!
7+
//! The [rx_asynch] and [tx_asynch] modules provide an asynchronous non-blocking API for the UART
8+
//! peripheral.
9+
//!
310
//! ## Examples
411
//!
512
//! - [UART simple example](https://egit.irs.uni-stuttgart.de/rust/va108xx-rs/src/branch/main/examples/simple/examples/uart.rs)

0 commit comments

Comments
 (0)