Skip to content

Commit de4c03b

Browse files
committed
Fix documentation lint
CFGR::hse was pointing to the private field. Instead point to the CFGR::use_hse function and improve wording a bit.
1 parent c460642 commit de4c03b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/rcc.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ impl CFGR {
425425
/// - Maximal supported frequency with `HSE`: 72 Mhz
426426
/// - Maximal supported frequency without `HSE`: 64 Mhz
427427
///
428-
/// If [`CFGR::hse`] is not used, therefor `HSI / 2` is used.
428+
/// If [`CFGR::use_hse`] is not set, `HSI / 2` will be used.
429429
/// Only multiples of (HSI / 2) (4 Mhz) are allowed.
430430
///
431431
/// This is true for devices **except** the following devices,
@@ -818,7 +818,7 @@ impl Clocks {
818818
/// Returns whether the USBCLK clock frequency is valid for the USB peripheral
819819
///
820820
/// If the microcontroller does support USB, 48 Mhz or 72 Mhz have to be used
821-
/// and the [`CFGR::hse`] must be used.
821+
/// and the [`CFGR::use_hse`] must be set.
822822
///
823823
/// The APB1 / [`CFGR::pclk1`] clock must have a minimum frequency of 10 MHz to avoid data
824824
/// overrun/underrun problems. [RM0316 32.5.2][RM0316]

0 commit comments

Comments
 (0)