summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-13 03:18:17 +0200
committerLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-13 03:18:17 +0200
commit4e9428bc5ad99c521858aae61cb6acc6d2c8bf52 (patch)
tree233aa2c3bc261db89fb08feac797068bf181d77c
parent94c8b9639ca2d287c504345390585b80dc0d78cf (diff)
downloadiced-4e9428bc5ad99c521858aae61cb6acc6d2c8bf52.tar.gz
iced-4e9428bc5ad99c521858aae61cb6acc6d2c8bf52.tar.bz2
iced-4e9428bc5ad99c521858aae61cb6acc6d2c8bf52.zip
Fix broken doc links in `keyboard::key`
-rw-r--r--core/src/keyboard/key.rs12
1 files changed, 6 insertions, 6 deletions
diff --git a/core/src/keyboard/key.rs b/core/src/keyboard/key.rs
index 219452d7..479d999b 100644
--- a/core/src/keyboard/key.rs
+++ b/core/src/keyboard/key.rs
@@ -1201,14 +1201,14 @@ pub enum Code {
F35,
}
-/// Contains the platform-native physical key identifier
+/// Contains the platform-native physical key identifier.
///
/// The exact values vary from platform to platform (which is part of why this is a per-platform
/// enum), but the values are primarily tied to the key's physical location on the keyboard.
///
/// This enum is primarily used to store raw keycodes when Winit doesn't map a given native
-/// physical key identifier to a meaningful [`KeyCode`] variant. In the presence of identifiers we
-/// haven't mapped for you yet, this lets you use use [`KeyCode`] to:
+/// physical key identifier to a meaningful [`Code`] variant. In the presence of identifiers we
+/// haven't mapped for you yet, this lets you use use [`Code`] to:
///
/// - Correctly match key press and release events.
/// - On non-web platforms, support assigning keybinds to virtually any key through a UI.
@@ -1228,16 +1228,16 @@ pub enum NativeCode {
/// Represents the location of a physical key.
///
-/// This type is a superset of [`KeyCode`], including an [`Unidentified`][Self::Unidentified]
+/// This type is a superset of [`Code`], including an [`Unidentified`][Self::Unidentified]
/// variant.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Physical {
/// A known key code
Code(Code),
- /// This variant is used when the key cannot be translated to a [`KeyCode`]
+ /// This variant is used when the key cannot be translated to a [`Code`]
///
/// The native keycode is provided (if available) so you're able to more reliably match
- /// key-press and key-release events by hashing the [`PhysicalKey`]. It is also possible to use
+ /// key-press and key-release events by hashing the [`Physical`] key. It is also possible to use
/// this for keybinds for non-standard keys, but such keybinds are tied to a given platform.
Unidentified(NativeCode),
}