Skip to content

Commit f67987f

Browse files
committed
multiboot2: fill in missing module documentations
1 parent 65730ef commit f67987f

12 files changed

+28
-5
lines changed

multiboot2/src/boot_loader_name.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Module for [`BootLoaderNameTag`].
2+
13
use crate::{Tag, TagTrait, TagType, TagTypeId};
24
use core::fmt::{Debug, Formatter};
35
use core::mem::size_of;

multiboot2/src/command_line.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Module for [CommandLineTag].
1+
//! Module for [`CommandLineTag`].
22
33
use crate::{Tag, TagTrait, TagType, TagTypeId};
44

multiboot2/src/efi.rs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
//! All MBI tags related to (U)EFI.
1+
//! All tags related to (U)EFI with the exception of EFI memory tags:
2+
//!
3+
//! - [`EFISdt32Tag`]
4+
//! - [`EFISdt64Tag`]
5+
//! - [`EFIImageHandle32Tag`]
6+
//! - [`EFIImageHandle64Tag`]
7+
//! - [`EFIBootServicesNotExitedTag`]
28
39
use crate::TagTypeId;
410
use crate::{Tag, TagTrait, TagType};

multiboot2/src/elf_sections.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Module for [`ElfSectionsTag`].
2+
13
#[cfg(feature = "builder")]
24
use crate::builder::BoxedDst;
35
use crate::{Tag, TagTrait, TagType, TagTypeId};

multiboot2/src/framebuffer.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Module for [`FramebufferTag`].
2+
13
use crate::{Tag, TagTrait, TagType, TagTypeId};
24
use core::fmt::Debug;
35
use core::mem::size_of;

multiboot2/src/image_load_addr.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Module for [`ImageLoadPhysAddrTag`].
2+
13
use crate::{Tag, TagTrait, TagType, TagTypeId};
24
#[cfg(feature = "builder")]
35
use {core::convert::TryInto, core::mem::size_of};

multiboot2/src/memory_map.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
//! Module for [`MemoryMapTag`], [`EFIMemoryMapTag`] and [`BasicMemoryInfoTag`]
2+
//! and corresponding helper types.
3+
14
pub use uefi_raw::table::boot::MemoryDescriptor as EFIMemoryDesc;
25
pub use uefi_raw::table::boot::MemoryType as EFIMemoryAreaType;
36

multiboot2/src/module.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
use crate::{Tag, TagIter, TagTrait, TagType, TagTypeId};
1+
//! Module for [`ModuleTag`].
22
3+
use crate::{Tag, TagIter, TagTrait, TagType, TagTypeId};
34
use core::fmt::{Debug, Formatter};
45
use core::mem::size_of;
56
use core::str::Utf8Error;

multiboot2/src/rsdp.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Module for [`RsdpV1Tag`] and [`RsdpV2Tag`].
2+
13
//! Module for RSDP/ACPI. RSDP (Root System Description Pointer) is a data structure used in the
24
//! ACPI programming interface.
35
//!

multiboot2/src/smbios.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Module for [`SmbiosTag`].
2+
13
#[cfg(feature = "builder")]
24
use crate::builder::BoxedDst;
35
use crate::{Tag, TagTrait, TagType, TagTypeId};

multiboot2/src/tag.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Module for the base tag definition.
1+
//! Module for the base tag definitions and helper types.
22
//!
33
//! The relevant exports of this module is [`Tag`].
44

multiboot2/src/vbe_info.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Module for [`VBEInfoTag`].
2+
13
use crate::{Tag, TagTrait, TagType, TagTypeId};
24
use core::fmt;
35

@@ -319,7 +321,6 @@ bitflags! {
319321
}
320322

321323
bitflags! {
322-
323324
/// The DirectColorModeInfo field describes important characteristics of direct color modes.
324325
///
325326
/// Bit D0 specifies whether the color ramp of the DAC is fixed or

0 commit comments

Comments
 (0)