diff options
| author | Gabriel Smith <[email protected]> | 2022-11-27 16:32:18 -0500 |
|---|---|---|
| committer | Gabriel Smith <[email protected]> | 2022-11-27 16:32:18 -0500 |
| commit | 4d84b5469ece6e7ad1597b6da41972a0ea391672 (patch) | |
| tree | f7430ced5f326544ff5e7f2cee8ef8e5adbd1a2b | |
| parent | 3ca14ba4e9feee2f0d34c8dd1c0e426d2090d8d8 (diff) | |
Drive-by documentation link fixes
| -rw-r--r-- | embassy-rp/src/rtc/mod.rs | 2 | ||||
| -rw-r--r-- | embassy-usb-driver/src/lib.rs | 4 | ||||
| -rw-r--r-- | embassy-usb/src/class/hid.rs | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/embassy-rp/src/rtc/mod.rs b/embassy-rp/src/rtc/mod.rs index e4b6f0b1d..c173909c7 100644 --- a/embassy-rp/src/rtc/mod.rs +++ b/embassy-rp/src/rtc/mod.rs | |||
| @@ -164,7 +164,7 @@ impl<'d, T: Instance> RealTimeClock<'d, T> { | |||
| 164 | } | 164 | } |
| 165 | } | 165 | } |
| 166 | 166 | ||
| 167 | /// Errors that can occur on methods on [RtcClock] | 167 | /// Errors that can occur on methods on [RealTimeClock] |
| 168 | #[derive(Clone, Debug, PartialEq, Eq)] | 168 | #[derive(Clone, Debug, PartialEq, Eq)] |
| 169 | pub enum RtcError { | 169 | pub enum RtcError { |
| 170 | /// An invalid DateTime was given or stored on the hardware. | 170 | /// An invalid DateTime was given or stored on the hardware. |
diff --git a/embassy-usb-driver/src/lib.rs b/embassy-usb-driver/src/lib.rs index 0a76ba6fb..9300ff812 100644 --- a/embassy-usb-driver/src/lib.rs +++ b/embassy-usb-driver/src/lib.rs | |||
| @@ -184,7 +184,7 @@ pub trait Bus { | |||
| 184 | /// | 184 | /// |
| 185 | /// # Errors | 185 | /// # Errors |
| 186 | /// | 186 | /// |
| 187 | /// * [`Unsupported`](crate::driver::Unsupported) - This UsbBus implementation doesn't support | 187 | /// * [`Unsupported`](crate::Unsupported) - This UsbBus implementation doesn't support |
| 188 | /// simulating a disconnect or it has not been enabled at creation time. | 188 | /// simulating a disconnect or it has not been enabled at creation time. |
| 189 | fn force_reset(&mut self) -> Result<(), Unsupported> { | 189 | fn force_reset(&mut self) -> Result<(), Unsupported> { |
| 190 | Err(Unsupported) | 190 | Err(Unsupported) |
| @@ -194,7 +194,7 @@ pub trait Bus { | |||
| 194 | /// | 194 | /// |
| 195 | /// # Errors | 195 | /// # Errors |
| 196 | /// | 196 | /// |
| 197 | /// * [`Unsupported`](crate::driver::Unsupported) - This UsbBus implementation doesn't support | 197 | /// * [`Unsupported`](crate::Unsupported) - This UsbBus implementation doesn't support |
| 198 | /// remote wakeup or it has not been enabled at creation time. | 198 | /// remote wakeup or it has not been enabled at creation time. |
| 199 | async fn remote_wakeup(&mut self) -> Result<(), Unsupported>; | 199 | async fn remote_wakeup(&mut self) -> Result<(), Unsupported>; |
| 200 | } | 200 | } |
diff --git a/embassy-usb/src/class/hid.rs b/embassy-usb/src/class/hid.rs index 4d1fa995f..b967aba0e 100644 --- a/embassy-usb/src/class/hid.rs +++ b/embassy-usb/src/class/hid.rs | |||
| @@ -299,7 +299,7 @@ impl<'d, D: Driver<'d>, const N: usize> HidReader<'d, D, N> { | |||
| 299 | /// **Note:** If `N` > the maximum packet size of the endpoint (i.e. output | 299 | /// **Note:** If `N` > the maximum packet size of the endpoint (i.e. output |
| 300 | /// reports may be split across multiple packets) and this method's future | 300 | /// reports may be split across multiple packets) and this method's future |
| 301 | /// is dropped after some packets have been read, the next call to `read()` | 301 | /// is dropped after some packets have been read, the next call to `read()` |
| 302 | /// will return a [`ReadError::SyncError()`]. The range in the sync error | 302 | /// will return a [`ReadError::Sync`]. The range in the sync error |
| 303 | /// indicates the portion `buf` that was filled by the current call to | 303 | /// indicates the portion `buf` that was filled by the current call to |
| 304 | /// `read()`. If the dropped future used the same `buf`, then `buf` will | 304 | /// `read()`. If the dropped future used the same `buf`, then `buf` will |
| 305 | /// contain the full report. | 305 | /// contain the full report. |
