Skip to content

Commit e218401

Browse files
committed
uefi: doc: link to Protocol type in more places
1 parent 9b406a8 commit e218401

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

uefi/src/boot.rs

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -853,12 +853,14 @@ pub fn protocols_per_handle(handle: Handle) -> Result<ProtocolsPerHandle> {
853853
})
854854
}
855855

856-
/// Locates the handle of a device on the device path that supports the specified protocol.
856+
/// Locates the handle of a device on the [`DevicePath`] that supports the
857+
/// specified [`Protocol`].
857858
///
858-
/// The `device_path` is updated to point at the remaining part of the [`DevicePath`] after
859-
/// the part that matched the protocol. For example, it can be used with a device path
860-
/// that contains a file path to strip off the file system portion of the device path,
861-
/// leaving the file path and handle to the file system driver needed to access the file.
859+
/// The `device_path` is updated to point at the remaining part that matched the
860+
/// protocol. For example, this function can be used with a device path that
861+
/// contains a file path to strip off the file system portion of the device
862+
/// path, leaving the file path and handle to the file system driver needed to
863+
/// access the file.
862864
///
863865
/// If the first node of `device_path` matches the protocol, the `device_path`
864866
/// is advanced to the device path terminator node. If `device_path` is a
@@ -959,7 +961,7 @@ pub fn locate_handle_buffer(search_ty: SearchType) -> Result<HandleBuffer> {
959961
})
960962
}
961963

962-
/// Returns all the handles implementing a certain protocol.
964+
/// Returns all the handles implementing a certain [`Protocol`].
963965
///
964966
/// # Errors
965967
///
@@ -1038,7 +1040,7 @@ pub fn get_handle_for_protocol<P: ProtocolPointer + ?Sized>() -> Result<Handle>
10381040
.ok_or_else(|| Status::NOT_FOUND.into())
10391041
}
10401042

1041-
/// Opens a protocol interface for a handle.
1043+
/// Opens a [`Protocol`] interface for a handle.
10421044
///
10431045
/// See also [`open_protocol_exclusive`], which provides a safe subset of this
10441046
/// functionality.
@@ -1101,7 +1103,7 @@ pub unsafe fn open_protocol<P: ProtocolPointer + ?Sized>(
11011103
})
11021104
}
11031105

1104-
/// Opens a protocol interface for a handle in exclusive mode.
1106+
/// Opens a [`Protocol`] interface for a handle in exclusive mode.
11051107
///
11061108
/// If successful, a [`ScopedProtocol`] is returned that will automatically
11071109
/// close the protocol interface when dropped.
@@ -1129,7 +1131,7 @@ pub fn open_protocol_exclusive<P: ProtocolPointer + ?Sized>(
11291131
}
11301132
}
11311133

1132-
/// Tests whether a handle supports a protocol.
1134+
/// Tests whether a handle supports a [`Protocol`].
11331135
///
11341136
/// Returns `Ok(true)` if the handle supports the protocol, `Ok(false)` if not.
11351137
///
@@ -1543,7 +1545,7 @@ impl Deref for ProtocolsPerHandle {
15431545
}
15441546

15451547
/// A buffer returned by [`locate_handle_buffer`] that contains an array of
1546-
/// [`Handle`]s that support the requested protocol.
1548+
/// [`Handle`]s that support the requested [`Protocol`].
15471549
#[derive(Debug, Eq, PartialEq)]
15481550
pub struct HandleBuffer {
15491551
count: usize,
@@ -1564,7 +1566,7 @@ impl Deref for HandleBuffer {
15641566
}
15651567
}
15661568

1567-
/// An open protocol interface. Automatically closes the protocol
1569+
/// An open [`Protocol`] interface. Automatically closes the protocol
15681570
/// interface on drop.
15691571
///
15701572
/// Most protocols have interface data associated with them. `ScopedProtocol`

0 commit comments

Comments
 (0)