docs: add comment for pub struct and enum

src/lib.rs

@@ -60,18 +60,23 @@ mod platform_impl;
 pub use self::error::*;
 use hotkey::HotKey;
 
+/// Describes the state of the [`HotKey`].
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
 pub enum HotKeyState {
+    /// The [`HotKey`] is pressed (the key is down).  
     Pressed,
+    /// The [`HotKey`] is released (the key is up).  
     Released,
 }
 
-/// Contains the id of the triggered [`HotKey`].
-/// Describes a global hotkey event emitted when a [`HotKey`] is pressed.
+/// Contains the id of the triggered [`HotKey`] and the state.
+/// Describes a global hotkey event emitted when a [`HotKey`] is pressed or released.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
 pub struct GlobalHotKeyEvent {
     /// Id of the associated [`HotKey`].
     pub id: u32,
+    /// State of the associated [`HotKey`].
+    /// The event was triggered by the [`HotKey`] changing to this state.
     pub state: HotKeyState,
 }