style: cargo doc fixes and improvements

Author: phip1611

uefi/src/boot.rs

@@ -143,7 +143,7 @@ pub unsafe fn raise_tpl(tpl: Tpl) -> TplGuard {
 ///
 /// * [`Status::OUT_OF_RESOURCES`]: allocation failed.
 /// * [`Status::INVALID_PARAMETER`]: `mem_ty` is [`MemoryType::PERSISTENT_MEMORY`],
-///   [`MemoryType::UNACCEPTED`], or in the range [`MemoryType::MAX`]`..=0x6fff_ffff`.
+///   [`MemoryType::UNACCEPTED`], or in the range [`MemoryType::MAX`] `..=0x6fff_ffff`.
 /// * [`Status::NOT_FOUND`]: the requested pages could not be found.
 pub fn allocate_pages(
     allocation_type: AllocateType,
@@ -229,7 +229,7 @@ pub unsafe fn free_pages(ptr: NonNull<u8>, count: usize) -> Result {
 ///
 /// * [`Status::OUT_OF_RESOURCES`]: allocation failed.
 /// * [`Status::INVALID_PARAMETER`]: `mem_ty` is [`MemoryType::PERSISTENT_MEMORY`],
-///   [`MemoryType::UNACCEPTED`], or in the range [`MemoryType::MAX`]`..=0x6fff_ffff`.
+///   [`MemoryType::UNACCEPTED`], or in the range [`MemoryType::MAX`] `..=0x6fff_ffff`.
 pub fn allocate_pool(memory_type: MemoryType, size: usize) -> Result<NonNull<u8>> {
     let bt = boot_services_raw_panicking();
     let bt = unsafe { bt.as_ref() };
@@ -531,7 +531,9 @@ pub fn check_event(event: Event) -> Result<bool> {
     }
 }
 
-/// Places the supplied `event` in the signaled state. If `event` is already in
+/// Places the supplied `event` in the signaled state.
+///
+/// If `event` is already in
 /// the signaled state, the function returns successfully. If `event` is of type
 /// [`NOTIFY_SIGNAL`], the event's notification function is scheduled to be
 /// invoked at the event's notification task priority level.

uefi/src/mem/memory_map/mod.rs

@@ -60,7 +60,9 @@ impl Align for MemoryDescriptor {
 pub struct MemoryMapKey(pub(crate) usize);
 
 /// A structure containing the meta attributes associated with a call to
-/// `GetMemoryMap` of UEFI. Note that all values refer to the time this was
+/// `GetMemoryMap` of UEFI.
+///
+/// Note that all values refer to the time this was
 /// called. All following invocations (hidden, subtle, and asynchronous ones)
 /// will likely invalidate this.
 #[derive(Copy, Clone, Debug)]

uefi/src/proto/media/file/mod.rs

@@ -1,7 +1,9 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
-//! This module provides the `FileHandle` structure as well as the more specific `RegularFile` and
-//! `Directory` structures. This module also provides the `File` trait for opening, querying,
+//! This module provides the [`FileHandle`] structure as well as the more
+//! specific [`RegularFile`] and [`Directory`] structures.
+//!
+//! This module also provides the [`File`] trait for opening, querying,
 //! creating, reading, and writing files.
 //!
 //! Usually a file system implementation will return a "root" directory, representing

uefi/src/runtime.rs

@@ -256,7 +256,7 @@ pub fn variable_keys() -> VariableKeys {
 
 /// Iterator over all UEFI variables.
 ///
-/// Each iteration yields a `Result<`[`VariableKey`]`>`. Error values:
+/// Each iteration yields a `Result<` [`VariableKey`] `>`. Error values:
 ///
 /// * [`Status::DEVICE_ERROR`]: variable could not be read due to a hardware error.
 /// * [`Status::UNSUPPORTED`]: this platform does not support variable storage
@@ -514,7 +514,9 @@ pub fn reset(reset_type: ResetType, status: Status, data: Option<&[u8]>) -> ! {
 }
 
 /// Changes the runtime addressing mode of EFI firmware from physical to
-/// virtual. It is up to the caller to translate the old system table address
+/// virtual.
+///
+/// It is up to the caller to translate the old system table address
 /// to a new virtual address and provide it for this function.
 ///
 /// If successful, this function will call [`set_system_table`] with
@@ -906,7 +908,9 @@ impl Display for VariableKey {
 }
 
 /// Information about UEFI variable storage space returned by
-/// [`query_variable_info`]. Note that the data here is
+/// [`query_variable_info`].
+///
+/// Note that the data here is
 /// limited to a specific type of variable (as specified by the
 /// `attributes` argument to `query_variable_info`).
 #[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]