doc(efivar): Document reader module

For the reason the parse module is made pub(crate), see github:rust-lang/rust/issues/83049
iTrooz · Sep 1, 2023 · 32cb649 · 32cb649
1 parent d02fd4b
commit 32cb649
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/efivar/src/boot/mod.rs b/efivar/src/boot/mod.rs
@@ -1,7 +1,7 @@
 //! This module handles everything related to boot entries
 
 mod boot_entry_iter;
-mod parse;
+pub(crate) mod parse;
 mod reader;
 mod writer;
 

diff --git a/efivar/src/boot/reader.rs b/efivar/src/boot/reader.rs
@@ -1,3 +1,5 @@
+//! This module contains functions to read boot entries. Actual boot entry parsing is done in [`crate::boot::parse`]
+
 use byteorder::{LittleEndian, ReadBytesExt};
 
 use crate::{efi::Variable, VarReader};