From a14b8bffc0037cc14f55b361b9591cf2657e6348 Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Thu, 29 Aug 2019 01:35:37 +0200
Subject: Write documentation for `input`
---
src/input/button_state.rs | 4 ++++
src/input/keyboard.rs | 1 +
src/input/mouse.rs | 1 +
src/input/mouse/button.rs | 8 ++++++++
4 files changed, 14 insertions(+)
(limited to 'src/input')
diff --git a/src/input/button_state.rs b/src/input/button_state.rs
index e8845cc7..988043ba 100644
--- a/src/input/button_state.rs
+++ b/src/input/button_state.rs
@@ -1,5 +1,9 @@
+/// The state of a button.
#[derive(Debug, Hash, Ord, PartialOrd, PartialEq, Eq, Clone, Copy)]
pub enum ButtonState {
+ /// The button is pressed.
Pressed,
+
+ /// The button is __not__ pressed.
Released,
}
diff --git a/src/input/keyboard.rs b/src/input/keyboard.rs
index 2b0188ff..57c24484 100644
--- a/src/input/keyboard.rs
+++ b/src/input/keyboard.rs
@@ -1,3 +1,4 @@
+//! Build keyboard events.
mod event;
mod key_code;
diff --git a/src/input/mouse.rs b/src/input/mouse.rs
index 49a62961..d37f5b96 100644
--- a/src/input/mouse.rs
+++ b/src/input/mouse.rs
@@ -1,3 +1,4 @@
+//! Build mouse events.
mod button;
mod event;
diff --git a/src/input/mouse/button.rs b/src/input/mouse/button.rs
index c51bedfc..aeb8a55d 100644
--- a/src/input/mouse/button.rs
+++ b/src/input/mouse/button.rs
@@ -1,7 +1,15 @@
+/// The button of a mouse.
#[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
pub enum Button {
+ /// The left mouse button.
Left,
+
+ /// The right mouse button.
Right,
+
+ /// The middle (wheel) button.
Middle,
+
+ /// Some other button.
Other(u8),
}
--
cgit