@@ -819,9 +819,10 @@ pub fn protocols_per_handle(handle: Handle) -> Result<ProtocolsPerHandle> {
819819 } )
820820}
821821
822- /// Locates the handle of a device on the device path that supports the specified protocol.
822+ /// Locates the handle of a device on the [`DevicePath`] that supports the
823+ /// specified [`Protocol`].
823824///
824- /// The `device_path` is updated to point at the remaining part of the [`DevicePath`] after
825+ /// The `device_path` is updated to point at the remaining part of it after
825826/// the part that matched the protocol. For example, it can be used with a device path
826827/// that contains a file path to strip off the file system portion of the device path,
827828/// leaving the file path and handle to the file system driver needed to access the file.
@@ -925,7 +926,7 @@ pub fn locate_handle_buffer(search_ty: SearchType) -> Result<HandleBuffer> {
925926 } )
926927}
927928
928- /// Returns all the handles implementing a certain protocol .
929+ /// Returns all the handles implementing a certain [`Protocol`] .
929930///
930931/// # Errors
931932///
@@ -1004,7 +1005,7 @@ pub fn get_handle_for_protocol<P: ProtocolPointer + ?Sized>() -> Result<Handle>
10041005 . ok_or_else ( || Status :: NOT_FOUND . into ( ) )
10051006}
10061007
1007- /// Opens a protocol interface for a handle.
1008+ /// Opens a [`Protocol`] interface for a handle.
10081009///
10091010/// See also [`open_protocol_exclusive`], which provides a safe subset of this
10101011/// functionality.
@@ -1067,7 +1068,7 @@ pub unsafe fn open_protocol<P: ProtocolPointer + ?Sized>(
10671068 } )
10681069}
10691070
1070- /// Opens a protocol interface for a handle in exclusive mode.
1071+ /// Opens a [`Protocol`] interface for a handle in exclusive mode.
10711072///
10721073/// If successful, a [`ScopedProtocol`] is returned that will automatically
10731074/// close the protocol interface when dropped.
@@ -1095,7 +1096,7 @@ pub fn open_protocol_exclusive<P: ProtocolPointer + ?Sized>(
10951096 }
10961097}
10971098
1098- /// Tests whether a handle supports a protocol .
1099+ /// Tests whether a handle supports a [`Protocol`] .
10991100///
11001101/// Returns `Ok(true)` if the handle supports the protocol, `Ok(false)` if not.
11011102///
@@ -1494,7 +1495,7 @@ impl Deref for ProtocolsPerHandle {
14941495}
14951496
14961497/// A buffer returned by [`locate_handle_buffer`] that contains an array of
1497- /// [`Handle`]s that support the requested protocol .
1498+ /// [`Handle`]s that support the requested [`Protocol`] .
14981499#[ derive( Debug , Eq , PartialEq ) ]
14991500pub struct HandleBuffer {
15001501 count : usize ,
@@ -1515,7 +1516,7 @@ impl Deref for HandleBuffer {
15151516 }
15161517}
15171518
1518- /// An open protocol interface. Automatically closes the protocol
1519+ /// An open [`Protocol`] interface. Automatically closes the protocol
15191520/// interface on drop.
15201521///
15211522/// Most protocols have interface data associated with them. `ScopedProtocol`
0 commit comments