@@ -853,9 +853,10 @@ pub fn protocols_per_handle(handle: Handle) -> Result<ProtocolsPerHandle> {
853
853
} )
854
854
}
855
855
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`].
857
858
///
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
859
860
/// the part that matched the protocol. For example, it can be used with a device path
860
861
/// that contains a file path to strip off the file system portion of the device path,
861
862
/// 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> {
959
960
} )
960
961
}
961
962
962
- /// Returns all the handles implementing a certain protocol .
963
+ /// Returns all the handles implementing a certain [`Protocol`] .
963
964
///
964
965
/// # Errors
965
966
///
@@ -1038,7 +1039,7 @@ pub fn get_handle_for_protocol<P: ProtocolPointer + ?Sized>() -> Result<Handle>
1038
1039
. ok_or_else ( || Status :: NOT_FOUND . into ( ) )
1039
1040
}
1040
1041
1041
- /// Opens a protocol interface for a handle.
1042
+ /// Opens a [`Protocol`] interface for a handle.
1042
1043
///
1043
1044
/// See also [`open_protocol_exclusive`], which provides a safe subset of this
1044
1045
/// functionality.
@@ -1101,7 +1102,7 @@ pub unsafe fn open_protocol<P: ProtocolPointer + ?Sized>(
1101
1102
} )
1102
1103
}
1103
1104
1104
- /// Opens a protocol interface for a handle in exclusive mode.
1105
+ /// Opens a [`Protocol`] interface for a handle in exclusive mode.
1105
1106
///
1106
1107
/// If successful, a [`ScopedProtocol`] is returned that will automatically
1107
1108
/// close the protocol interface when dropped.
@@ -1129,7 +1130,7 @@ pub fn open_protocol_exclusive<P: ProtocolPointer + ?Sized>(
1129
1130
}
1130
1131
}
1131
1132
1132
- /// Tests whether a handle supports a protocol .
1133
+ /// Tests whether a handle supports a [`Protocol`] .
1133
1134
///
1134
1135
/// Returns `Ok(true)` if the handle supports the protocol, `Ok(false)` if not.
1135
1136
///
@@ -1543,7 +1544,7 @@ impl Deref for ProtocolsPerHandle {
1543
1544
}
1544
1545
1545
1546
/// 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`] .
1547
1548
#[ derive( Debug , Eq , PartialEq ) ]
1548
1549
pub struct HandleBuffer {
1549
1550
count : usize ,
@@ -1564,7 +1565,7 @@ impl Deref for HandleBuffer {
1564
1565
}
1565
1566
}
1566
1567
1567
- /// An open protocol interface. Automatically closes the protocol
1568
+ /// An open [`Protocol`] interface. Automatically closes the protocol
1568
1569
/// interface on drop.
1569
1570
///
1570
1571
/// Most protocols have interface data associated with them. `ScopedProtocol`
0 commit comments