From 5fd2f770a1eff20e9264bcc39a4fc377431203ef Mon Sep 17 00:00:00 2001
From: Philipp Schuster <phip1611@gmail.com>
Date: Thu, 21 Sep 2023 16:33:37 +0200
Subject: [PATCH] multiboot2: fill in missing module documentations

---
 multiboot2/src/boot_loader_name.rs | 2 ++
 multiboot2/src/command_line.rs     | 2 +-
 multiboot2/src/efi.rs              | 8 +++++++-
 multiboot2/src/elf_sections.rs     | 2 ++
 multiboot2/src/framebuffer.rs      | 2 ++
 multiboot2/src/image_load_addr.rs  | 2 ++
 multiboot2/src/memory_map.rs       | 3 +++
 multiboot2/src/module.rs           | 2 ++
 multiboot2/src/rsdp.rs             | 2 ++
 multiboot2/src/smbios.rs           | 2 ++
 multiboot2/src/tag.rs              | 2 +-
 multiboot2/src/vbe_info.rs         | 3 ++-
 12 files changed, 28 insertions(+), 4 deletions(-)

diff --git a/multiboot2/src/boot_loader_name.rs b/multiboot2/src/boot_loader_name.rs
index c57fee5c..93b12e0d 100644
--- a/multiboot2/src/boot_loader_name.rs
+++ b/multiboot2/src/boot_loader_name.rs
@@ -1,3 +1,5 @@
+//! Module for [`BootLoaderNameTag`].
+
 use crate::tag::StringError;
 use crate::{Tag, TagTrait, TagType, TagTypeId};
 use core::fmt::{Debug, Formatter};
diff --git a/multiboot2/src/command_line.rs b/multiboot2/src/command_line.rs
index df7dd47a..e2b168f8 100644
--- a/multiboot2/src/command_line.rs
+++ b/multiboot2/src/command_line.rs
@@ -1,4 +1,4 @@
-//! Module for [CommandLineTag].
+//! Module for [`CommandLineTag`].
 
 use crate::{Tag, TagTrait, TagType, TagTypeId};
 
diff --git a/multiboot2/src/efi.rs b/multiboot2/src/efi.rs
index 99972ff1..a80325ca 100644
--- a/multiboot2/src/efi.rs
+++ b/multiboot2/src/efi.rs
@@ -1,4 +1,10 @@
-//! All MBI tags related to (U)EFI.
+//! All tags related to (U)EFI with the exception of EFI memory tags:
+//!
+//! - [`EFISdt32Tag`]
+//! - [`EFISdt64Tag`]
+//! - [`EFIImageHandle32Tag`]
+//! - [`EFIImageHandle64Tag`]
+//! - [`EFIBootServicesNotExitedTag`]
 
 use crate::TagTypeId;
 use crate::{Tag, TagTrait, TagType};
diff --git a/multiboot2/src/elf_sections.rs b/multiboot2/src/elf_sections.rs
index d41ab114..00579359 100644
--- a/multiboot2/src/elf_sections.rs
+++ b/multiboot2/src/elf_sections.rs
@@ -1,3 +1,5 @@
+//! Module for [`ElfSectionsTag`].
+
 #[cfg(feature = "builder")]
 use crate::builder::BoxedDst;
 use crate::{Tag, TagTrait, TagType, TagTypeId};
diff --git a/multiboot2/src/framebuffer.rs b/multiboot2/src/framebuffer.rs
index 62acf067..bb80dc25 100644
--- a/multiboot2/src/framebuffer.rs
+++ b/multiboot2/src/framebuffer.rs
@@ -1,3 +1,5 @@
+//! Module for [`FramebufferTag`].
+
 use crate::{Tag, TagTrait, TagType, TagTypeId};
 use core::fmt::Debug;
 use core::mem::size_of;
diff --git a/multiboot2/src/image_load_addr.rs b/multiboot2/src/image_load_addr.rs
index 306e5013..efb1b49e 100644
--- a/multiboot2/src/image_load_addr.rs
+++ b/multiboot2/src/image_load_addr.rs
@@ -1,3 +1,5 @@
+//! Module for [`ImageLoadPhysAddrTag`].
+
 use crate::{Tag, TagTrait, TagType, TagTypeId};
 #[cfg(feature = "builder")]
 use {core::convert::TryInto, core::mem::size_of};
diff --git a/multiboot2/src/memory_map.rs b/multiboot2/src/memory_map.rs
index a94df130..c502551e 100644
--- a/multiboot2/src/memory_map.rs
+++ b/multiboot2/src/memory_map.rs
@@ -1,3 +1,6 @@
+//! Module for [`MemoryMapTag`], [`EFIMemoryMapTag`] and [`BasicMemoryInfoTag`]
+//! and corresponding helper types.
+
 pub use uefi_raw::table::boot::MemoryDescriptor as EFIMemoryDesc;
 pub use uefi_raw::table::boot::MemoryType as EFIMemoryAreaType;
 
diff --git a/multiboot2/src/module.rs b/multiboot2/src/module.rs
index e2578cfb..84c8f2b2 100644
--- a/multiboot2/src/module.rs
+++ b/multiboot2/src/module.rs
@@ -1,3 +1,5 @@
+//! Module for [`ModuleTag`].
+
 use crate::tag::StringError;
 use crate::{Tag, TagIter, TagTrait, TagType, TagTypeId};
 use core::fmt::{Debug, Formatter};
diff --git a/multiboot2/src/rsdp.rs b/multiboot2/src/rsdp.rs
index ec5f9a62..12a5b723 100644
--- a/multiboot2/src/rsdp.rs
+++ b/multiboot2/src/rsdp.rs
@@ -1,3 +1,5 @@
+//! Module for [`RsdpV1Tag`] and  [`RsdpV2Tag`].
+
 //! Module for RSDP/ACPI. RSDP (Root System Description Pointer) is a data structure used in the
 //! ACPI programming interface.
 //!
diff --git a/multiboot2/src/smbios.rs b/multiboot2/src/smbios.rs
index 56f9abe3..5c34c7d8 100644
--- a/multiboot2/src/smbios.rs
+++ b/multiboot2/src/smbios.rs
@@ -1,3 +1,5 @@
+//! Module for [`SmbiosTag`].
+
 #[cfg(feature = "builder")]
 use crate::builder::BoxedDst;
 use crate::{Tag, TagTrait, TagType, TagTypeId};
diff --git a/multiboot2/src/tag.rs b/multiboot2/src/tag.rs
index 435ff9b9..fe7dd524 100644
--- a/multiboot2/src/tag.rs
+++ b/multiboot2/src/tag.rs
@@ -1,4 +1,4 @@
-//! Module for the base tag definition.
+//! Module for the base tag definitions and helper types.
 //!
 //! The relevant exports of this module is [`Tag`].
 
diff --git a/multiboot2/src/vbe_info.rs b/multiboot2/src/vbe_info.rs
index 7b7035a6..a5973f4c 100644
--- a/multiboot2/src/vbe_info.rs
+++ b/multiboot2/src/vbe_info.rs
@@ -1,3 +1,5 @@
+//! Module for [`VBEInfoTag`].
+
 use crate::{Tag, TagTrait, TagType, TagTypeId};
 use core::fmt;
 
@@ -319,7 +321,6 @@ bitflags! {
 }
 
 bitflags! {
-
     /// The DirectColorModeInfo field describes important characteristics of direct color modes.
     ///
     /// Bit D0 specifies whether the color ramp of the DAC is fixed or