Skip to content

Commit 1d737d8

Browse files
committed
zephyr: Fill in some missing doc comments
Fix doc build errors by filling in missing documentation comments. Signed-off-by: David Brown <[email protected]>
1 parent 6153d7d commit 1d737d8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

zephyr/src/sys.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,12 @@ pub mod flash {
149149
150150
use crate::raw;
151151

152+
/// A flash controller
153+
///
154+
/// This is a wrapper around the `struct device` in Zephyr that represents a flash controller.
155+
/// Using the flash controller allows flash operations on the entire device. See
156+
/// [`FlashPartition`] for a wrapper that limits the operation to a partition as defined in the
157+
/// DT.
152158
#[allow(dead_code)]
153159
pub struct FlashController {
154160
pub(crate) device: *const raw::device,

0 commit comments

Comments
 (0)