Skip to content

Commit 7480cfd

Browse files
committed
uefi: doc: link to Protocol type in more places
1 parent 3bf2db7 commit 7480cfd

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

uefi/src/boot.rs

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -853,9 +853,10 @@ 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 `device_path` is updated to point at the remaining part of it after
859860
/// the part that matched the protocol. For example, it can be used with a device path
860861
/// that contains a file path to strip off the file system portion of the device path,
861862
/// leaving the file path and handle to the file system driver needed to access the file.
@@ -959,7 +960,7 @@ pub fn locate_handle_buffer(search_ty: SearchType) -> Result<HandleBuffer> {
959960
})
960961
}
961962

962-
/// Returns all the handles implementing a certain protocol.
963+
/// Returns all the handles implementing a certain [`Protocol`].
963964
///
964965
/// # Errors
965966
///
@@ -1038,7 +1039,7 @@ pub fn get_handle_for_protocol<P: ProtocolPointer + ?Sized>() -> Result<Handle>
10381039
.ok_or_else(|| Status::NOT_FOUND.into())
10391040
}
10401041

1041-
/// Opens a protocol interface for a handle.
1042+
/// Opens a [`Protocol`] interface for a handle.
10421043
///
10431044
/// See also [`open_protocol_exclusive`], which provides a safe subset of this
10441045
/// functionality.
@@ -1101,7 +1102,7 @@ pub unsafe fn open_protocol<P: ProtocolPointer + ?Sized>(
11011102
})
11021103
}
11031104

1104-
/// Opens a protocol interface for a handle in exclusive mode.
1105+
/// Opens a [`Protocol`] interface for a handle in exclusive mode.
11051106
///
11061107
/// If successful, a [`ScopedProtocol`] is returned that will automatically
11071108
/// close the protocol interface when dropped.
@@ -1129,7 +1130,7 @@ pub fn open_protocol_exclusive<P: ProtocolPointer + ?Sized>(
11291130
}
11301131
}
11311132

1132-
/// Tests whether a handle supports a protocol.
1133+
/// Tests whether a handle supports a [`Protocol`].
11331134
///
11341135
/// Returns `Ok(true)` if the handle supports the protocol, `Ok(false)` if not.
11351136
///
@@ -1543,7 +1544,7 @@ impl Deref for ProtocolsPerHandle {
15431544
}
15441545

15451546
/// A buffer returned by [`locate_handle_buffer`] that contains an array of
1546-
/// [`Handle`]s that support the requested protocol.
1547+
/// [`Handle`]s that support the requested [`Protocol`].
15471548
#[derive(Debug, Eq, PartialEq)]
15481549
pub struct HandleBuffer {
15491550
count: usize,
@@ -1564,7 +1565,7 @@ impl Deref for HandleBuffer {
15641565
}
15651566
}
15661567

1567-
/// An open protocol interface. Automatically closes the protocol
1568+
/// An open [`Protocol`] interface. Automatically closes the protocol
15681569
/// interface on drop.
15691570
///
15701571
/// Most protocols have interface data associated with them. `ScopedProtocol`

0 commit comments

Comments
 (0)