Skip to content

Commit 2b593fe

Browse files
authored
Merge pull request #1376 from nicholasbishop/bishop-update-pointer-docs
uefi: Update pointer protocol docs
2 parents a54e5cd + 0ce4985 commit 2b593fe

File tree

1 file changed

+6
-2
lines changed
  • uefi/src/proto/console/pointer

1 file changed

+6
-2
lines changed

uefi/src/proto/console/pointer/mod.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ impl Pointer {
2626
/// Retrieves the pointer device's current state, if a state change occurred
2727
/// since the last time this function was called.
2828
///
29-
/// Use `wait_for_input_event()` with the `BootServices::wait_for_event()`
29+
/// Use `wait_for_input_event()` with the [`boot::wait_for_event`]
3030
/// interface in order to wait for input from the pointer device.
3131
///
3232
/// # Errors
3333
/// - `DeviceError` if there was an issue with the pointer device.
34+
///
35+
/// [`boot::wait_for_event`]: crate::boot::wait_for_event
3436
pub fn read_state(&mut self) -> Result<Option<PointerState>> {
3537
let mut pointer_state = PointerState::default();
3638
let pointer_state_ptr: *mut _ = &mut pointer_state;
@@ -41,8 +43,10 @@ impl Pointer {
4143
}
4244
}
4345

44-
/// Event to be used with `BootServices::wait_for_event()` in order to wait
46+
/// Event to be used with [`boot::wait_for_event`] in order to wait
4547
/// for input from the pointer device
48+
///
49+
/// [`boot::wait_for_event`]: crate::boot::wait_for_event
4650
#[must_use]
4751
pub fn wait_for_input_event(&self) -> Option<Event> {
4852
unsafe { Event::from_ptr(self.0.wait_for_input) }

0 commit comments

Comments
 (0)