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 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/input/button_state.rs')

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,
 }
-- 
cgit