@@ -819,9 +819,10 @@ pub fn protocols_per_handle(handle: Handle) -> Result<ProtocolsPerHandle> {
819
819
} )
820
820
}
821
821
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`].
823
824
///
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
825
826
/// the part that matched the protocol. For example, it can be used with a device path
826
827
/// that contains a file path to strip off the file system portion of the device path,
827
828
/// 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> {
925
926
} )
926
927
}
927
928
928
- /// Returns all the handles implementing a certain protocol .
929
+ /// Returns all the handles implementing a certain [`Protocol`] .
929
930
///
930
931
/// # Errors
931
932
///
@@ -1004,7 +1005,7 @@ pub fn get_handle_for_protocol<P: ProtocolPointer + ?Sized>() -> Result<Handle>
1004
1005
. ok_or_else ( || Status :: NOT_FOUND . into ( ) )
1005
1006
}
1006
1007
1007
- /// Opens a protocol interface for a handle.
1008
+ /// Opens a [`Protocol`] interface for a handle.
1008
1009
///
1009
1010
/// See also [`open_protocol_exclusive`], which provides a safe subset of this
1010
1011
/// functionality.
@@ -1067,7 +1068,7 @@ pub unsafe fn open_protocol<P: ProtocolPointer + ?Sized>(
1067
1068
} )
1068
1069
}
1069
1070
1070
- /// Opens a protocol interface for a handle in exclusive mode.
1071
+ /// Opens a [`Protocol`] interface for a handle in exclusive mode.
1071
1072
///
1072
1073
/// If successful, a [`ScopedProtocol`] is returned that will automatically
1073
1074
/// close the protocol interface when dropped.
@@ -1095,7 +1096,7 @@ pub fn open_protocol_exclusive<P: ProtocolPointer + ?Sized>(
1095
1096
}
1096
1097
}
1097
1098
1098
- /// Tests whether a handle supports a protocol .
1099
+ /// Tests whether a handle supports a [`Protocol`] .
1099
1100
///
1100
1101
/// Returns `Ok(true)` if the handle supports the protocol, `Ok(false)` if not.
1101
1102
///
@@ -1494,7 +1495,7 @@ impl Deref for ProtocolsPerHandle {
1494
1495
}
1495
1496
1496
1497
/// 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`] .
1498
1499
#[ derive( Debug , Eq , PartialEq ) ]
1499
1500
pub struct HandleBuffer {
1500
1501
count : usize ,
@@ -1515,7 +1516,7 @@ impl Deref for HandleBuffer {
1515
1516
}
1516
1517
}
1517
1518
1518
- /// An open protocol interface. Automatically closes the protocol
1519
+ /// An open [`Protocol`] interface. Automatically closes the protocol
1519
1520
/// interface on drop.
1520
1521
///
1521
1522
/// Most protocols have interface data associated with them. `ScopedProtocol`
0 commit comments