summaryrefslogtreecommitdiffstats
path: root/src/input/keyboard
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-09-05 09:59:38 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-09-05 09:59:38 +0200
commitc48739029b36e4380409cdb15594e415afce6371 (patch)
tree129d2834819570a75db5f970daa6e1ee5c1587e4 /src/input/keyboard
parent3fb06f66661b5f4f0a76553164597f7ce0cbd79c (diff)
downloadiced-c48739029b36e4380409cdb15594e415afce6371.tar.gz
iced-c48739029b36e4380409cdb15594e415afce6371.tar.bz2
iced-c48739029b36e4380409cdb15594e415afce6371.zip
Ask users to share use cases
Diffstat (limited to 'src/input/keyboard')
-rw-r--r--src/input/keyboard/event.rs5
-rw-r--r--src/input/keyboard/key_code.rs9
2 files changed, 11 insertions, 3 deletions
diff --git a/src/input/keyboard/event.rs b/src/input/keyboard/event.rs
index 5acd46c0..8118f112 100644
--- a/src/input/keyboard/event.rs
+++ b/src/input/keyboard/event.rs
@@ -3,6 +3,11 @@ use crate::input::ButtonState;
#[derive(Debug, Clone, Copy, PartialEq)]
/// A keyboard event.
+///
+/// _**Note:** This type is largely incomplete! If you need to track
+/// additional events, feel free to [open an issue] and share your use case!_
+///
+/// [open an issue]: https://github.com/hecrj/iced/issues
pub enum Event {
/// A keyboard key was pressed or released.
Input {
diff --git a/src/input/keyboard/key_code.rs b/src/input/keyboard/key_code.rs
index 9b449735..207ddeac 100644
--- a/src/input/keyboard/key_code.rs
+++ b/src/input/keyboard/key_code.rs
@@ -1,8 +1,11 @@
/// The symbolic name of a keyboard key.
///
-/// This is mostly the `KeyCode` type found in `winit`. If you are using
-/// `winit`, consider enabling the `winit` feature to get conversion
-/// implementations for free!
+/// This is mostly the `KeyCode` type found in [`winit`].
+///
+/// If you are using [`winit`], consider enabling the `winit` feature to get
+/// conversion implementations for free!
+///
+/// [`winit`]: https://docs.rs/winit/0.20.0-alpha3/winit/
#[derive(Debug, Hash, Ord, PartialOrd, PartialEq, Eq, Clone, Copy)]
#[repr(u32)]
#[allow(missing_docs)]