itsscb/embassy
1
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2025-09-26 20:00:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

embassy-rp: fix rom_data module documentation

Browse Source 
Removes module doc comment markers that appeared in the generated
documentation.
This commit is contained in:
Rob Wells 2025-06-16 13:11:46 +01:00
parent 56572ef0ad
commit 2613295111
No known key found for this signature in database
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
embassy-rp/src/rom_data/mod.rs
View File

@ -1,29 +1,29 @@
#![cfg_attr(
feature = "rp2040",
doc = r"
//! Functions and data from the RPI Bootrom.
//!
//! From the [RP2040 datasheet](https://datasheets.raspberrypi.org/rp2040/rp2040-datasheet.pdf), Section 2.8.2.1:
//!
//! > The Bootrom contains a number of public functions that provide useful
//! > RP2040 functionality that might be needed in the absence of any other code
//! > on the device, as well as highly optimized versions of certain key
//! > functionality that would otherwise have to take up space in most user
//! > binaries.
Functions and data from the RPI Bootrom.
From the [RP2040 datasheet](https://datasheets.raspberrypi.org/rp2040/rp2040-datasheet.pdf), Section 2.8.2.1:
> The Bootrom contains a number of public functions that provide useful
> RP2040 functionality that might be needed in the absence of any other code
> on the device, as well as highly optimized versions of certain key
> functionality that would otherwise have to take up space in most user
> binaries.
"
)]
#![cfg_attr(
feature = "_rp235x",
doc = r"
//! Functions and data from the RPI Bootrom.
//!
//! From [Section 5.4](https://rptl.io/rp2350-datasheet#section_bootrom) of the
//! RP2350 datasheet:
//!
//! > Whilst some ROM space is dedicated to the implementation of the boot
//! > sequence and USB/UART boot interfaces, the bootrom also contains public
//! > functions that provide useful RP2350 functionality that may be useful for
//! > any code or runtime running on the device
Functions and data from the RPI Bootrom.
From [Section 5.4](https://rptl.io/rp2350-datasheet#section_bootrom) of the
RP2350 datasheet:
> Whilst some ROM space is dedicated to the implementation of the boot
> sequence and USB/UART boot interfaces, the bootrom also contains public
> functions that provide useful RP2350 functionality that may be useful for
> any code or runtime running on the device
"
)]