rust/va108xx-rs
7
0
Fork 0
Code Issues Pull Requests Projects Releases 19 Wiki Activity

doc fixes

Browse Source
This commit is contained in:
Robin Müller
2025-04-16 14:44:32 +02:00
parent 121b467fb9
commit 5c1f05fb32
7 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
va108xx-hal/src/spi/mod.rs
View File

@ -1,7 +1,7 @@
//! API for the SPI peripheral.
//!
//! The main abstraction provided by this module are the [Spi] and the [SpiBase] structure.
//! These provide the [embedded_hal::spi] traits, but also offer a low level interface
//! The main abstraction provided by this module is the [Spi] an structure.
//! It provides the [embedded_hal::spi] traits, but also offer a low level interface
//! via the [SpiLowLevel] trait.
//!
//! ## Examples

2
va108xx-hal/src/timer.rs
View File

@ -290,7 +290,7 @@ pub type TimRegBlock = tim0::RegisterBlock;
///
/// # Safety
///
/// Users should only implement the [Self::tim_id] function. No default function
/// Users should only implement the [Self::raw_id] function. No default function
/// implementations should be overridden. The implementing type must also have
/// "control" over the corresponding pin ID, i.e. it must guarantee that a each
/// pin ID is a singleton.

8
va108xx-hal/src/uart/mod.rs
View File

@ -1,6 +1,6 @@
//! # API for the UART peripheral
//!
//! The core of this API are the [Uart], [UartBase], [Rx] and [Tx] structures.
//! The core of this API are the [Uart], [Rx] and [Tx] structures.
//! The RX structure also has a dedicated [RxWithInterrupt] variant which allows reading the receiver
//! using interrupts.
//!
@ -510,7 +510,7 @@ pub struct UartIdMissmatchError;
// UART implementation
//==================================================================================================
/// Type erased variant of a UART. Can be created with the [`Uart::downgrade`] function.
/// UART driver structure.
pub struct Uart {
tx: Tx,
rx: Rx,
@ -793,7 +793,7 @@ pub fn disable_rx_interrupts(uart: &uart_base::RegisterBlock) {
/// Serial receiver.
///
/// Can be created by using the [Uart::split] or [UartBase::split] API.
/// Can be created by using the [Uart::split] API.
pub struct Rx(UartId);
impl Rx {
@ -963,7 +963,7 @@ pub fn disable_tx_interrupts(uart: &uart_base::RegisterBlock) {
/// Serial transmitter
///
/// Can be created by using the [Uart::split] or [UartBase::split] API.
/// Can be created by using the [Uart::split] API.
pub struct Tx(UartId);
impl Tx {