From 21f1077b79652a3273ffe9e360454c7766302989 Mon Sep 17 00:00:00 2001
From: Robin Mueller <robin.mueller.m@gmail.com>
Date: Mon, 23 Sep 2024 11:49:05 +0200
Subject: [PATCH] more docs

---
 va416xx-hal/src/uart.rs | 4 ++++
 1 file changed, 4 insertions(+)

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)