Skip to content

Commit 03b8dcf

Browse files
committed
Tidy cargo doc warnings, fix links in rcc
1 parent a2ef40c commit 03b8dcf

File tree

6 files changed

+18
-20
lines changed

6 files changed

+18
-20
lines changed

src/adc.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! Analog to Digital Converter (ADC)
22
//!
33
//! ADC1 and ADC2 share a reset line. To initialise both of them, use the
4-
//! [`adc12`](adc12) method.
4+
//! [`adc12`] method.
55
//!
66
//! # Examples
77
//!
@@ -999,7 +999,7 @@ macro_rules! adc_hal {
999999

10001000
/// Set ADC sampling time
10011001
///
1002-
/// Options can be found in [AdcSampleTime](crate::adc::AdcSampleTime).
1002+
/// Options can be found in [AdcSampleTime].
10031003
pub fn set_sample_time(&mut self, t_samp: AdcSampleTime) {
10041004
self.sample_time = t_samp;
10051005
}

src/delay.rs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
//! Delay providers
22
//!
33
//! There are currently two delay providers. In general you should prefer to use
4-
//! [Delay](Delay), however if you do not have access to `SYST` you can use
5-
//! [DelayFromCountDownTimer](DelayFromCountDownTimer) with any timer that
6-
//! implements the [CountDown](embedded_hal::timer::CountDown) trait. This can be
7-
//! useful if you're using [RTIC](https://rtic.rs)'s schedule API, which occupies
8-
//! the `SYST` peripheral.
4+
//! [Delay], however if you do not have access to `SYST` you can use
5+
//! [DelayFromCountDownTimer] with any timer that implements the [CountDown]
6+
//! trait. This can be useful if you're using [RTIC](https://rtic.rs)'s schedule
7+
//! API, which occupies the `SYST` peripheral.
98
//!
109
//! # Examples
1110
//!
@@ -68,7 +67,7 @@ pub struct Delay {
6867
syst: SYST,
6968
}
7069

71-
/// Implements [CountDown](embedded_hal::timer::CountDown) for the System timer (SysTick).
70+
/// Implements [CountDown] for the System timer (SysTick).
7271
pub struct Countdown<'a> {
7372
clocks: CoreClocks,
7473
syst: &'a mut SYST,

src/dma/mdma.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@
4444
//! Unlike DMA1/DMA2, it is valid to assign the same request line to multiple
4545
//! MDMA streams. Additionally there are multiple requests lines to choose from
4646
//! for each target peripheral. For this reason, hardware request lines are
47-
//! specified as part of the [`MdmaConfig`](MdmaConfig) instead of being
48-
//! inferred from the peripheral type. If no hardware request line is specified,
49-
//! then the request line originates from software and the transfer is started
50-
//! immediately when [`enable`](Stream0#method.enable) is called.
47+
//! specified as part of the [`MdmaConfig`] instead of being inferred from the
48+
//! peripheral type. If no hardware request line is specified, then the request
49+
//! line originates from software and the transfer is started immediately when
50+
//! [`enable`](Stream0#method.enable) is called.
5151
//!
5252
//!
5353

src/dma/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
//!
2020
//! The following table summarizes the available DMA controllers
2121
//!
22-
//! | Controller | Accessible Memories | Peripheral [TargetAddress](traits::TargetAddress) Implementations | Double Buffering Supported ? | Number of DMA Streams | Initialization Method
22+
//! | Controller | Accessible Memories | Peripheral [TargetAddress] Implementations | Double Buffering Supported ? | Number of DMA Streams | Initialization Method
2323
//! | --- | --- | --- | --- | --- | ---
2424
//! | [MDMA](mdma) | All | `QUADSPI`, .. | No |16| [Transfer::init_master](Transfer#method.init_master)
2525
//! | [DMA1](dma) | AXISRAM, SRAM1/2/3/4 | all others [^notimpl] | Yes |8| [Transfer::init](Transfer#method.init)
2626
//! | [DMA2](dma) | AXISRAM, SRAM1/2/3/4 | all others [^notimpl] | Yes |8| [Transfer::init](Transfer#method.init)
2727
//! | [BDMA](bdma) | SRAM4 [^rm0455bdma] | `LPUART1`, `SPI6`, `I2C4`, `SAI4` | Yes |8| [Transfer::init](Transfer#method.init)
2828
//!
29-
//! [^notimpl]: [TargetAddress](traits::TargetAddress) is not yet implemented
29+
//! [^notimpl]: [TargetAddress] is not yet implemented
3030
//! for many peripherals
3131
//!
3232
//! [^rm0455bdma]: On 7B3/7A3/7B0 parts there are two BDMA controllers. BDMA1

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
//!
4747
//! * [Direct Memory Access (DMA)](crate::dma)
4848
//! * [Cyclic Redundancy Check (CRC)](crate::crc) Feature gate `crc`
49-
//! * [Random Number Generator](crate::rng) ([rand_core::RngCore](rand_core::RngCore) is implemented under the `rand` feature gate)
49+
//! * [Random Number Generator](crate::rng) ([rand_core::RngCore] is implemented under the `rand` feature gate)
5050
//! * [Embedded Flash Memory](crate::flash)
5151
//! * [System Window Watchdog](crate::system_watchdog)
5252
//! * [Independent Watchdog](crate::independent_watchdog)

src/rcc/mod.rs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,9 @@
108108
//! # Peripherals
109109
//!
110110
//! The `freeze()` method returns a [Core Clocks Distribution and Reset
111-
//! (CCDR)](struct.Ccdr.html) object. This singleton tells you how the core
112-
//! clocks were actually configured (in [CoreClocks](struct.CoreClocks.html))
113-
//! and allows you to configure the remaining peripherals (see
114-
//! [PeripheralREC](crate::rcc::rec::struct.PeripheralREC.html)).
111+
//! (CCDR)](Ccdr) object. This singleton tells you how the core clocks were
112+
//! actually configured (in [CoreClocks]) and allows you to configure the
113+
//! remaining peripherals (see [PeripheralREC]).
115114
//!
116115
//!```rust
117116
//! let ccdr = ...; // Returned by `freeze()`, see examples above
@@ -126,7 +125,7 @@
126125
//! ccdr.peripheral.FDCAN.enable().reset();
127126
//!```
128127
//!
129-
//! The [PeripheralREC](struct.PeripheralREC.html) members implement move
128+
//! The [PeripheralREC] members implement move
130129
//! semantics, so once you have passed them to a constructor they cannot be
131130
//! modified again in safe Rust.
132131
//!

0 commit comments

Comments
 (0)