alex/rp-hal-boards
1
0
Fork 0
mirror of https://github.com/italicsjenga/rp-hal-boards.git synced 2024-12-24 05:01:31 +11:00
Code Issues Packages Projects Releases Wiki Activity

Add #Safety tag to unsafe rationale docstring

Browse source
This commit is contained in:
9names 2021-05-04 18:08:06 +10:00
parent 691f43c17b
commit 416baf6405
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
rp2040-hal/src/xosc.rs
View file

@ -175,6 +175,8 @@ impl CrystalOscillator<Stable> {
} }
/// Put the XOSC in DORMANT state. /// Put the XOSC in DORMANT state.
///
/// # Safety
/// This method is marked unsafe because prior to switch the XOSC into DORMANT state, /// This method is marked unsafe because prior to switch the XOSC into DORMANT state,
/// PLLs must be stopped and IRQs have to be properly configured. /// PLLs must be stopped and IRQs have to be properly configured.
/// This method does not do any of that, it merely switches the XOSC to DORMANT state. /// This method does not do any of that, it merely switches the XOSC to DORMANT state.