From 9ae4edfa73d33f6fe66eb70a896b14267f6cdec2 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 23 Sep 2025 11:21:57 +0200 Subject: [PATCH] doc fixes --- embassy-nrf/src/gpio.rs | 4 ++-- embassy-nrf/src/i2s.rs | 2 +- embassy-nrf/src/lib.rs | 2 +- embassy-nrf/src/twim.rs | 4 ++-- embassy-nrf/src/twis.rs | 2 +- embassy-nrf/src/usb/vbus_detect.rs | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/embassy-nrf/src/gpio.rs b/embassy-nrf/src/gpio.rs index 0cea38777..ab5e7ed4b 100644 --- a/embassy-nrf/src/gpio.rs +++ b/embassy-nrf/src/gpio.rs @@ -217,7 +217,7 @@ pub struct Output<'d> { } impl<'d> Output<'d> { - /// Create GPIO output driver for a [Pin] with the provided [Level] and [OutputDriver] configuration. + /// Create GPIO output driver for a [Pin] with the provided [Level] and [OutputDrive] configuration. #[inline] pub fn new(pin: Peri<'d, impl Pin>, initial_output: Level, drive: OutputDrive) -> Self { let mut pin = Flex::new(pin); @@ -781,7 +781,7 @@ impl<'d> embedded_hal_1::digital::ErrorType for Flex<'d> { type Error = Infallible; } -/// Implement [`InputPin`] for [`Flex`]; +/// Implement [embedded_hal_1::digital::InputPin] for [`Flex`]; /// /// If the pin is not in input mode the result is unspecified. impl<'d> embedded_hal_1::digital::InputPin for Flex<'d> { diff --git a/embassy-nrf/src/i2s.rs b/embassy-nrf/src/i2s.rs index a7dde8cd7..53de8deee 100644 --- a/embassy-nrf/src/i2s.rs +++ b/embassy-nrf/src/i2s.rs @@ -252,7 +252,7 @@ impl ApproxSampleRate { /// /// Those are non standard sample rates that can be configured without error. /// -/// For custom master clock configuration, please refer to [Mode]. +/// For custom master clock configuration, please refer to [vals::Mode]. #[derive(Clone, Copy)] pub enum ExactSampleRate { /// 8000 Hz diff --git a/embassy-nrf/src/lib.rs b/embassy-nrf/src/lib.rs index e0847a312..7c26a6184 100644 --- a/embassy-nrf/src/lib.rs +++ b/embassy-nrf/src/lib.rs @@ -207,7 +207,7 @@ mod chip; /// Macro to bind interrupts to handlers. /// /// This defines the right interrupt handlers, and creates a unit struct (like `struct Irqs;`) -/// and implements the right [`Binding`]s for it. You can pass this struct to drivers to +/// and implements the right [crate::interrupt::typelevel::Binding]s for it. You can pass this struct to drivers to /// prove at compile-time that the right interrupts have been bound. /// /// Example of how to bind one interrupt: diff --git a/embassy-nrf/src/twim.rs b/embassy-nrf/src/twim.rs index 3d5e841d1..3fc59a39a 100644 --- a/embassy-nrf/src/twim.rs +++ b/embassy-nrf/src/twim.rs @@ -558,7 +558,7 @@ impl<'d, T: Instance> Twim<'d, T> { /// Execute the provided operations on the I2C bus with timeout. /// - /// See [`blocking_transaction`]. + /// See [Self::blocking_transaction]. #[cfg(feature = "time")] pub fn blocking_transaction_timeout( &mut self, @@ -632,7 +632,7 @@ impl<'d, T: Instance> Twim<'d, T> { /// Write to an I2C slave with timeout. /// - /// See [`blocking_write`]. + /// See [Self::blocking_write]. #[cfg(feature = "time")] pub fn blocking_write_timeout(&mut self, address: u8, buffer: &[u8], timeout: Duration) -> Result<(), Error> { self.blocking_transaction_timeout(address, &mut [Operation::Write(buffer)], timeout) diff --git a/embassy-nrf/src/twis.rs b/embassy-nrf/src/twis.rs index 3e4d537ae..c77d0f048 100644 --- a/embassy-nrf/src/twis.rs +++ b/embassy-nrf/src/twis.rs @@ -700,7 +700,7 @@ impl<'d, T: Instance> Twis<'d, T> { /// Respond to an I2C master READ command with timeout. /// Returns the number of bytes written. - /// See [`blocking_respond_to_read`]. + /// See [Self::blocking_respond_to_read]. #[cfg(feature = "time")] pub fn blocking_respond_to_read_timeout(&mut self, buffer: &[u8], timeout: Duration) -> Result { self.setup_respond(buffer, false)?; diff --git a/embassy-nrf/src/usb/vbus_detect.rs b/embassy-nrf/src/usb/vbus_detect.rs index 8794beb2d..33cf91ee2 100644 --- a/embassy-nrf/src/usb/vbus_detect.rs +++ b/embassy-nrf/src/usb/vbus_detect.rs @@ -68,7 +68,7 @@ impl interrupt::typelevel::Handler for InterruptHandler { /// [`VbusDetect`] implementation using the native hardware POWER peripheral. /// /// Unsuitable for usage with the nRF softdevice, since it reserves exclusive acces -/// to POWER. In that case, use [`VbusDetectSignal`]. +/// to POWER. In that case, use [SoftwareVbusDetect]. pub struct HardwareVbusDetect { _private: (), }