From df7e349c70447b4b4a8c0d4395cff0b1bd4c2489 Mon Sep 17 00:00:00 2001
From: David Harvey-Macaulay <alteous@outlook.com>
Date: Mon, 25 Sep 2017 14:58:59 +0100
Subject: [PATCH] Complete documentation for top-level items (#299)

---
 src/events.rs | 11 ++++++++++-
 src/lib.rs    |  1 +
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/events.rs b/src/events.rs
index 5b33a832..24b815ef 100644
--- a/src/events.rs
+++ b/src/events.rs
@@ -1,6 +1,7 @@
 use std::path::PathBuf;
 use {WindowId, DeviceId};
 
+/// Describes a generic event.
 #[derive(Clone, Debug)]
 pub enum Event {
     WindowEvent {
@@ -19,6 +20,7 @@ pub enum Event {
     Suspended(bool),
 }
 
+/// Describes an event from a `Window`.
 #[derive(Clone, Debug)]
 pub enum WindowEvent {
 
@@ -105,6 +107,7 @@ pub enum DeviceEvent {
     Text { codepoint: char },
 }
 
+/// Describes a keyboard input event.
 #[derive(Debug, Clone, Copy)]
 pub struct KeyboardInput {
     /// Identifies the physical key pressed
@@ -129,6 +132,7 @@ pub struct KeyboardInput {
     pub modifiers: ModifiersState
 }
 
+/// Describes touch-screen input state.
 #[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
 pub enum TouchPhase {
     Started,
@@ -137,7 +141,6 @@ pub enum TouchPhase {
     Cancelled
 }
 
-#[derive(Debug, Clone, Copy)]
 /// Represents touch event
 ///
 /// Every time user touches screen new Start event with some finger id is generated.
@@ -153,6 +156,7 @@ pub enum TouchPhase {
 /// as previously received End event is a new finger and has nothing to do with an old one.
 ///
 /// Touch may be cancelled if for example window lost focus.
+#[derive(Debug, Clone, Copy)]
 pub struct Touch {
     pub device_id: DeviceId,
     pub phase: TouchPhase,
@@ -161,6 +165,7 @@ pub struct Touch {
     pub id: u64
 }
 
+/// Hardware-dependent keyboard scan code.
 pub type ScanCode = u32;
 
 /// Identifier for a specific analog axis on some device.
@@ -169,12 +174,14 @@ pub type AxisId = u32;
 /// Identifier for a specific button on some device.
 pub type ButtonId = u32;
 
+/// Describes the input state of a key.
 #[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
 pub enum ElementState {
     Pressed,
     Released,
 }
 
+/// Describes a button of a mouse controller.
 #[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
 pub enum MouseButton {
     Left,
@@ -183,6 +190,7 @@ pub enum MouseButton {
     Other(u8),
 }
 
+/// Describes a difference in the mouse scroll wheel state.
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub enum MouseScrollDelta {
 	/// Amount in lines or rows to scroll in the horizontal
@@ -200,6 +208,7 @@ pub enum MouseScrollDelta {
 	PixelDelta(f32, f32)
 }
 
+/// Symbolic name for a keyboard key.
 #[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
 #[repr(u32)]
 pub enum VirtualKeyCode {
diff --git a/src/lib.rs b/src/lib.rs
index 9c93ebec..165713ff 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -310,6 +310,7 @@ impl std::error::Error for CreationError {
     }
 }
 
+/// Describes the appearance of the mouse cursor.
 #[derive(Debug, Copy, Clone, PartialEq)]
 pub enum MouseCursor {
     /// The platform-dependent default cursor.