Skip to content

Commit fad9745

Browse files
committed
multiboot2: doc fixes
1 parent fa10b30 commit fad9745

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

multiboot2/src/boot_information.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use crate::{
88
module, BasicMemoryInfoTag, BootLoaderNameTag, CommandLineTag, EFIBootServicesNotExitedTag,
99
EFIImageHandle32Tag, EFIImageHandle64Tag, EFIMemoryMapTag, EFISdt32Tag, EFISdt64Tag,
1010
ElfSectionIter, ElfSectionsTag, EndTag, FramebufferTag, ImageLoadPhysAddrTag, MemoryMapTag,
11-
ModuleIter, RsdpV1Tag, RsdpV2Tag, SmbiosTag, TagTrait, VBEInfoTag,
11+
ModuleIter, RsdpV1Tag, RsdpV2Tag, SmbiosTag, TagTrait, TagType, VBEInfoTag,
1212
};
1313
use core::fmt;
1414
use core::mem;
@@ -221,6 +221,8 @@ impl<'a> BootInformation<'a> {
221221
/// Otherwise, if the [`TagType::EfiBs`] tag is present, this returns `None`
222222
/// as it is strictly recommended to get the memory map from the `uefi`
223223
/// services.
224+
///
225+
/// [`TagType::EfiBs`]: crate::TagType::EfiBs
224226
#[must_use]
225227
pub fn efi_memory_map_tag(&self) -> Option<&EFIMemoryMapTag> {
226228
// If the EFIBootServicesNotExited is present, then we should not use

multiboot2/src/tag.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ use core::ops::Deref;
1717
use core::ptr;
1818

1919
/// The common header that all tags have in common. This type is ABI compatible.
20-
/// It is the sized counterpart of [`GenericTag`].
2120
///
2221
/// Not to be confused with Multiboot header tags, which are something
2322
/// different.
23+
///
24+
/// It is the sized counterpart of `GenericTag`, an internal type.
2425
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
2526
#[repr(C, align(8))] // Alignment also propagates to all tag types using this.
2627
pub struct TagHeader {

multiboot2/src/tag_type.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ use core::hash::Hash;
77

88
/// Serialized form of [`TagType`] that matches the binary representation
99
/// (`u32`). The abstraction corresponds to the `typ`/`type` field of a
10-
/// Multiboot2 [`Tag`]. This type can easily be created from or converted to
10+
/// Multiboot2 [`TagHeader`]. This type can easily be created from or converted to
1111
/// [`TagType`].
1212
///
13-
/// [`Tag`]: crate::Tag
13+
/// [`TagHeader`]: crate::TagHeader
1414
#[repr(transparent)]
1515
#[derive(Copy, Clone, PartialOrd, PartialEq, Eq, Ord, Hash)]
1616
pub struct TagTypeId(u32);

0 commit comments

Comments
 (0)