Skip to content

Commit 155b53f

Browse files
committed
docs: cargo doc warnings
1 parent 6212c61 commit 155b53f

File tree

5 files changed

+13
-12
lines changed

5 files changed

+13
-12
lines changed

src/adc.rs

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! Analog to digital converter configuration.
2-
//! https://github.com/stm32-rs/stm32l4xx-hal/blob/master/src/adc.rs
2+
//! <https://github.com/stm32-rs/stm32l4xx-hal/blob/master/src/adc.rs>
33
44
#![deny(missing_docs)]
55

@@ -310,7 +310,8 @@ pub mod config {
310310
pub enum ClockMode {
311311
/// (Asynchronous clock mode), adc_ker_ck. generated at product level (refer to Section 6: Reset and clock control (RCC)
312312
Asynchronous,
313-
/// (Synchronous clock mode). adc_hclk/1 This configuration must be enabled only if the AHB clock prescaler is set to 1 (HPRE[3:0] = 0xxx in RCC_CFGR register) and if the system clock has a 50% duty cycle.
313+
/// (Synchronous clock mode). adc_hclk/1
314+
/// This configuration must be enabled only if the AHB clock prescaler is set to 1 (HPRE\[3:0\] = 0xxx in RCC_CFGR register) and if the system clock has a 50% duty cycle.
314315
Synchronous_Div_1,
315316
/// Synchronous clock mode. adc_hclk/2
316317
Synchronous_Div_2,
@@ -1166,9 +1167,9 @@ impl<ADC: TriggerType> Conversion<ADC> {
11661167
!self.is_active()
11671168
}
11681169

1169-
/// Converts from Conversion<C, E> to Option<C>.
1170+
/// Converts from `Conversion<C, E>` to `Option<C>`.
11701171
///
1171-
/// Converts self into an Option<C>, consuming self, and discarding the adc, if it is stopped.
1172+
/// Converts self into an `Option<C>`, consuming self, and discarding the adc, if it is stopped.
11721173
#[inline(always)]
11731174
pub fn active(self) -> Option<Adc<ADC, Active>> {
11741175
match self {
@@ -1177,9 +1178,9 @@ impl<ADC: TriggerType> Conversion<ADC> {
11771178
}
11781179
}
11791180

1180-
/// Converts from Conversion<C, E> to Option<E>.
1181+
/// Converts from `Conversion<C, E>` to `Option<E>`.
11811182
///
1182-
/// Converts self into an Option<E>, consuming self, and discarding the adc, if it is still active.
1183+
/// Converts self into an `Option<E>`, consuming self, and discarding the adc, if it is still active.
11831184
#[inline(always)]
11841185
pub fn stopped(self) -> Option<Adc<ADC, Configured>> {
11851186
match self {

src/delay.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
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
4+
//! [Delay], however if you do not have access to `SYST` you can use
5+
//! [DelayFromCountDownTimer] with any timer that
6+
//! implements the [CountDown](embedded_hal_old::timer::CountDown) trait. This can be
77
//! useful if you're using [RTIC](https://rtic.rs)'s schedule API, which occupies
88
//! the `SYST` peripheral.
99
//!

src/dma.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
//! instructions in DMA controller configuration.
1414
//!
1515
//! Adapted from
16-
//! https://github.com/stm32-rs/stm32h7xx-hal/blob/master/src/dma/mod.rs
16+
//! <https://github.com/stm32-rs/stm32h7xx-hal/blob/master/src/dma/mod.rs>
1717
1818
use core::fmt::Debug;
1919

src/dma/traits.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! Traits for DMA types
22
//!
33
//! Adapted from
4-
//! https://github.com/stm32-rs/stm32f4xx-hal/blob/master/src/dma/traits.rs
4+
//! <https://github.com/stm32-rs/stm32f4xx-hal/blob/master/src/dma/traits.rs>
55
66
use super::*;
77

src/pwm.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1405,7 +1405,7 @@ macro_rules! tim_hal {
14051405
$(
14061406
impl<PINS, CHANNEL, COMP> PwmBuilder<$TIMX, PINS, CHANNEL, FaultDisabled, COMP, $typ> {
14071407
/// Configure a break pin that will disable PWM when activated (active level based on polarity argument)
1408-
/// Note: not all timers have fault inputs; FaultPins<TIM> is only implemented for valid pins/timers.
1408+
/// Note: not all timers have fault inputs; `FaultPins<TIM>` is only implemented for valid pins/timers.
14091409
pub fn with_break_pin<P: FaultPins<$TIMX>>(self, _pin: P, polarity: Polarity) -> PwmBuilder<$TIMX, PINS, CHANNEL, FaultEnabled, COMP, $typ> {
14101410
PwmBuilder {
14111411
_tim: PhantomData,

0 commit comments

Comments
 (0)