Selaa lähdekoodia

multiboot2: doc fixes

Philipp Schuster 8 kuukautta sitten
vanhempi
commit
8d39ec8ef1
3 muutettua tiedostoa jossa 7 lisäystä ja 4 poistoa
  1. 3 1
      multiboot2/src/boot_information.rs
  2. 2 1
      multiboot2/src/tag.rs
  3. 2 2
      multiboot2/src/tag_type.rs

+ 3 - 1
multiboot2/src/boot_information.rs

@@ -8,7 +8,7 @@ use crate::{
     module, BasicMemoryInfoTag, BootLoaderNameTag, CommandLineTag, EFIBootServicesNotExitedTag,
     EFIImageHandle32Tag, EFIImageHandle64Tag, EFIMemoryMapTag, EFISdt32Tag, EFISdt64Tag,
     ElfSectionIter, ElfSectionsTag, EndTag, FramebufferTag, ImageLoadPhysAddrTag, MemoryMapTag,
-    ModuleIter, RsdpV1Tag, RsdpV2Tag, SmbiosTag, TagTrait, VBEInfoTag,
+    ModuleIter, RsdpV1Tag, RsdpV2Tag, SmbiosTag, TagTrait, TagType, VBEInfoTag,
 };
 use core::fmt;
 use core::mem;
@@ -221,6 +221,8 @@ impl<'a> BootInformation<'a> {
     /// Otherwise, if the [`TagType::EfiBs`] tag is present, this returns `None`
     /// as it is strictly recommended to get the memory map from the `uefi`
     /// services.
+    ///
+    /// [`TagType::EfiBs`]: crate::TagType::EfiBs
     #[must_use]
     pub fn efi_memory_map_tag(&self) -> Option<&EFIMemoryMapTag> {
         // If the EFIBootServicesNotExited is present, then we should not use

+ 2 - 1
multiboot2/src/tag.rs

@@ -17,10 +17,11 @@ use core::ops::Deref;
 use core::ptr;
 
 /// The common header that all tags have in common. This type is ABI compatible.
-/// It is the sized counterpart of [`GenericTag`].
 ///
 /// Not to be confused with Multiboot header tags, which are something
 /// different.
+///
+/// It is the sized counterpart of `GenericTag`, an internal type.
 #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
 #[repr(C, align(8))] // Alignment also propagates to all tag types using this.
 pub struct TagHeader {

+ 2 - 2
multiboot2/src/tag_type.rs

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