@@ -853,12 +853,14 @@ 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 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.
862
864
///
863
865
/// If the first node of `device_path` matches the protocol, the `device_path`
864
866
/// 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> {
959
961
} )
960
962
}
961
963
962
- /// Returns all the handles implementing a certain protocol .
964
+ /// Returns all the handles implementing a certain [`Protocol`] .
963
965
///
964
966
/// # Errors
965
967
///
@@ -1038,7 +1040,7 @@ pub fn get_handle_for_protocol<P: ProtocolPointer + ?Sized>() -> Result<Handle>
1038
1040
. ok_or_else ( || Status :: NOT_FOUND . into ( ) )
1039
1041
}
1040
1042
1041
- /// Opens a protocol interface for a handle.
1043
+ /// Opens a [`Protocol`] interface for a handle.
1042
1044
///
1043
1045
/// See also [`open_protocol_exclusive`], which provides a safe subset of this
1044
1046
/// functionality.
@@ -1101,7 +1103,7 @@ pub unsafe fn open_protocol<P: ProtocolPointer + ?Sized>(
1101
1103
} )
1102
1104
}
1103
1105
1104
- /// Opens a protocol interface for a handle in exclusive mode.
1106
+ /// Opens a [`Protocol`] interface for a handle in exclusive mode.
1105
1107
///
1106
1108
/// If successful, a [`ScopedProtocol`] is returned that will automatically
1107
1109
/// close the protocol interface when dropped.
@@ -1129,7 +1131,7 @@ pub fn open_protocol_exclusive<P: ProtocolPointer + ?Sized>(
1129
1131
}
1130
1132
}
1131
1133
1132
- /// Tests whether a handle supports a protocol .
1134
+ /// Tests whether a handle supports a [`Protocol`] .
1133
1135
///
1134
1136
/// Returns `Ok(true)` if the handle supports the protocol, `Ok(false)` if not.
1135
1137
///
@@ -1543,7 +1545,7 @@ impl Deref for ProtocolsPerHandle {
1543
1545
}
1544
1546
1545
1547
/// 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`] .
1547
1549
#[ derive( Debug , Eq , PartialEq ) ]
1548
1550
pub struct HandleBuffer {
1549
1551
count : usize ,
@@ -1564,7 +1566,7 @@ impl Deref for HandleBuffer {
1564
1566
}
1565
1567
}
1566
1568
1567
- /// An open protocol interface. Automatically closes the protocol
1569
+ /// An open [`Protocol`] interface. Automatically closes the protocol
1568
1570
/// interface on drop.
1569
1571
///
1570
1572
/// Most protocols have interface data associated with them. `ScopedProtocol`
0 commit comments