diff options
| author | Robin Mueller <[email protected]> | 2025-09-23 11:21:57 +0200 |
|---|---|---|
| committer | Robin Mueller <[email protected]> | 2025-09-23 13:44:06 +0200 |
| commit | 9ae4edfa73d33f6fe66eb70a896b14267f6cdec2 (patch) | |
| tree | 36acda02d421b05b8633c2c8dfd48efaf44e8e48 | |
| parent | f3f29cdd531f5329d797c29af66c4aac1acd7574 (diff) | |
doc fixes
| -rw-r--r-- | embassy-nrf/src/gpio.rs | 4 | ||||
| -rw-r--r-- | embassy-nrf/src/i2s.rs | 2 | ||||
| -rw-r--r-- | embassy-nrf/src/lib.rs | 2 | ||||
| -rw-r--r-- | embassy-nrf/src/twim.rs | 4 | ||||
| -rw-r--r-- | embassy-nrf/src/twis.rs | 2 | ||||
| -rw-r--r-- | 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> { | |||
| 217 | } | 217 | } |
| 218 | 218 | ||
| 219 | impl<'d> Output<'d> { | 219 | impl<'d> Output<'d> { |
| 220 | /// Create GPIO output driver for a [Pin] with the provided [Level] and [OutputDriver] configuration. | 220 | /// Create GPIO output driver for a [Pin] with the provided [Level] and [OutputDrive] configuration. |
| 221 | #[inline] | 221 | #[inline] |
| 222 | pub fn new(pin: Peri<'d, impl Pin>, initial_output: Level, drive: OutputDrive) -> Self { | 222 | pub fn new(pin: Peri<'d, impl Pin>, initial_output: Level, drive: OutputDrive) -> Self { |
| 223 | let mut pin = Flex::new(pin); | 223 | let mut pin = Flex::new(pin); |
| @@ -781,7 +781,7 @@ impl<'d> embedded_hal_1::digital::ErrorType for Flex<'d> { | |||
| 781 | type Error = Infallible; | 781 | type Error = Infallible; |
| 782 | } | 782 | } |
| 783 | 783 | ||
| 784 | /// Implement [`InputPin`] for [`Flex`]; | 784 | /// Implement [embedded_hal_1::digital::InputPin] for [`Flex`]; |
| 785 | /// | 785 | /// |
| 786 | /// If the pin is not in input mode the result is unspecified. | 786 | /// If the pin is not in input mode the result is unspecified. |
| 787 | impl<'d> embedded_hal_1::digital::InputPin for Flex<'d> { | 787 | 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 { | |||
| 252 | /// | 252 | /// |
| 253 | /// Those are non standard sample rates that can be configured without error. | 253 | /// Those are non standard sample rates that can be configured without error. |
| 254 | /// | 254 | /// |
| 255 | /// For custom master clock configuration, please refer to [Mode]. | 255 | /// For custom master clock configuration, please refer to [vals::Mode]. |
| 256 | #[derive(Clone, Copy)] | 256 | #[derive(Clone, Copy)] |
| 257 | pub enum ExactSampleRate { | 257 | pub enum ExactSampleRate { |
| 258 | /// 8000 Hz | 258 | /// 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; | |||
| 207 | /// Macro to bind interrupts to handlers. | 207 | /// Macro to bind interrupts to handlers. |
| 208 | /// | 208 | /// |
| 209 | /// This defines the right interrupt handlers, and creates a unit struct (like `struct Irqs;`) | 209 | /// This defines the right interrupt handlers, and creates a unit struct (like `struct Irqs;`) |
| 210 | /// and implements the right [`Binding`]s for it. You can pass this struct to drivers to | 210 | /// and implements the right [crate::interrupt::typelevel::Binding]s for it. You can pass this struct to drivers to |
| 211 | /// prove at compile-time that the right interrupts have been bound. | 211 | /// prove at compile-time that the right interrupts have been bound. |
| 212 | /// | 212 | /// |
| 213 | /// Example of how to bind one interrupt: | 213 | /// 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> { | |||
| 558 | 558 | ||
| 559 | /// Execute the provided operations on the I2C bus with timeout. | 559 | /// Execute the provided operations on the I2C bus with timeout. |
| 560 | /// | 560 | /// |
| 561 | /// See [`blocking_transaction`]. | 561 | /// See [Self::blocking_transaction]. |
| 562 | #[cfg(feature = "time")] | 562 | #[cfg(feature = "time")] |
| 563 | pub fn blocking_transaction_timeout( | 563 | pub fn blocking_transaction_timeout( |
| 564 | &mut self, | 564 | &mut self, |
| @@ -632,7 +632,7 @@ impl<'d, T: Instance> Twim<'d, T> { | |||
| 632 | 632 | ||
| 633 | /// Write to an I2C slave with timeout. | 633 | /// Write to an I2C slave with timeout. |
| 634 | /// | 634 | /// |
| 635 | /// See [`blocking_write`]. | 635 | /// See [Self::blocking_write]. |
| 636 | #[cfg(feature = "time")] | 636 | #[cfg(feature = "time")] |
| 637 | pub fn blocking_write_timeout(&mut self, address: u8, buffer: &[u8], timeout: Duration) -> Result<(), Error> { | 637 | pub fn blocking_write_timeout(&mut self, address: u8, buffer: &[u8], timeout: Duration) -> Result<(), Error> { |
| 638 | self.blocking_transaction_timeout(address, &mut [Operation::Write(buffer)], timeout) | 638 | 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> { | |||
| 700 | 700 | ||
| 701 | /// Respond to an I2C master READ command with timeout. | 701 | /// Respond to an I2C master READ command with timeout. |
| 702 | /// Returns the number of bytes written. | 702 | /// Returns the number of bytes written. |
| 703 | /// See [`blocking_respond_to_read`]. | 703 | /// See [Self::blocking_respond_to_read]. |
| 704 | #[cfg(feature = "time")] | 704 | #[cfg(feature = "time")] |
| 705 | pub fn blocking_respond_to_read_timeout(&mut self, buffer: &[u8], timeout: Duration) -> Result<usize, Error> { | 705 | pub fn blocking_respond_to_read_timeout(&mut self, buffer: &[u8], timeout: Duration) -> Result<usize, Error> { |
| 706 | self.setup_respond(buffer, false)?; | 706 | 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<UsbRegIrq> for InterruptHandler { | |||
| 68 | /// [`VbusDetect`] implementation using the native hardware POWER peripheral. | 68 | /// [`VbusDetect`] implementation using the native hardware POWER peripheral. |
| 69 | /// | 69 | /// |
| 70 | /// Unsuitable for usage with the nRF softdevice, since it reserves exclusive acces | 70 | /// Unsuitable for usage with the nRF softdevice, since it reserves exclusive acces |
| 71 | /// to POWER. In that case, use [`VbusDetectSignal`]. | 71 | /// to POWER. In that case, use [SoftwareVbusDetect]. |
| 72 | pub struct HardwareVbusDetect { | 72 | pub struct HardwareVbusDetect { |
| 73 | _private: (), | 73 | _private: (), |
| 74 | } | 74 | } |
