Skip to content

Commit

Permalink
Fix documentation warnings after nearly two years
Browse files Browse the repository at this point in the history
  • Loading branch information
mciantyre committed Dec 20, 2024
1 parent 54152e7 commit ca73bc8
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
3 changes: 1 addition & 2 deletions src/channel.rs
Original file line number Diff line number Diff line change
Expand Up @@ -275,8 +275,7 @@ impl Channel {

/// Set the DMAMUX channel configuration
///
/// See the [`Configuration`](crate::channel::Configuration) documentation
/// for more information.
/// See the [`Configuration`] documentation for more information.
///
/// # Panics
///
Expand Down
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//!
//! # Getting started
//!
//! To allocate a [`Dma`](crate::Dma) driver, you'll need to know
//! To allocate a [`Dma`] driver, you'll need to know
//!
//! 1. the location of the DMA controller registers.
//! 2. the location of the DMAMUX registers.
Expand Down Expand Up @@ -47,9 +47,9 @@
//! peripheral using a single buffer.
//!
//! Peripheral transfers depends on a peripheral's DMA support. These are signaled
//! through various [`peripheral`](crate::peripheral) traits.
//! through various [`peripheral`] traits.
//!
//! For a lower-level API, use the [`channel`](crate::channel) objects and helper
//! For a lower-level API, use the [`channel`] objects and helper
//! functions.
//!
//! ### License
Expand Down
2 changes: 1 addition & 1 deletion src/memcpy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use core::{
/// A memcpy operation
///
/// `Memcpy` yields when it's moved the minimum amount of elements between two linear
/// buffers. Use the [`memcpy`](crate::memcpy::memcpy) function to define the transfer.
/// buffers. Use the [`memcpy`] function to define the transfer.
pub struct Memcpy<'a, E> {
transfer: Transfer<'a>,
channel: &'a Channel,
Expand Down
2 changes: 1 addition & 1 deletion src/peripheral.rs
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ pub unsafe trait Bidirectional<E: Element>: Source<E> + Destination<E> {}

/// A full-duplex DMA transfer from a single buffer
///
/// `FullDuplex` only works with [`Bidirectional`](crate::peripheral::Bidirectional)
/// `FullDuplex` only works with [`Bidirectional`]
/// peripherals. The transfer acts on a single buffer, sending and receiving data
/// element by element. It yields when all elements are sent and received.
///
Expand Down

0 comments on commit ca73bc8

Please sign in to comment.