docs: add more documentation

Author: nik-rev

src/config/commands.rs

@@ -7,16 +7,16 @@
 //! - Add the module to the `declare_global_commands!` macro invocation below
 //! - Implement the [`crate::command::Handler`] trait for the `Command` generated by `declare_commands!`.
 
-use ui::popup::keybindings_cheatsheet;
-
-use crate::ui;
-
 use super::key::{KeyMods, KeySequence};
+use crate::ui;
+use ui::popup::keybindings_cheatsheet;
 
 /// Handles commands which mutate state of the application.
 ///
 /// A `Command` is a subset of a `Message` which can be bound to a keybinding, and
 /// can therefore receive a `count`.
+///
+/// You should use this as `crate::command::Handler`.
 pub trait CommandHandler {
     /// Handle the invoked command, mutating the `App`.
     ///
@@ -58,7 +58,7 @@ pub trait CommandHandler {
 macro_rules! declare_commands {
     (
         $(#[$Command_Attr:meta])*
-        enum Command {
+        enum $Command:ident {
             $(
                 $(#[$Keymappable_Command_Attr:meta])*
                 $Keymappable_Command:ident $({$(
@@ -85,19 +85,13 @@ macro_rules! declare_commands {
             }
         )*
 
-        /// A list of keybindings which exist in the app
-        #[derive(ferrishot_knus::Decode, Debug, Clone)]
-        pub enum KeymappableCommand {
-            $(
-                $Keymappable_Command($Keymappable_Command),
-            )*
-        }
-
-        /// An action in the app
+        /// Contains a couple of commands, which are specific to this module.
+        ///
+        /// See [`Command`](crate::config::commands::Command) for more info.
         #[allow(clippy::derive_partial_eq_without_eq, reason = "f32 cannot derive `Eq`")]
         #[derive(Debug, Clone, PartialEq, Copy)]
         $(#[$Command_Attr])*
-        pub enum Command {
+        pub enum $Command {
             $(
                 $(#[$Keymappable_Command_Attr])*
                 $Keymappable_Command $(
@@ -110,7 +104,21 @@ macro_rules! declare_commands {
             )*
         }
 
+        /// Parses the corresponding commands in the KDL file.
+        ///
+        /// See [`KeymappableCommand`](crate::config::commands::KeymappableCommand) for more info.
+        #[derive(ferrishot_knus::Decode, Debug, Clone)]
+        pub enum KeymappableCommand {
+            $(
+                $Keymappable_Command($Keymappable_Command),
+            )*
+        }
+
         impl KeymappableCommand {
+            /// # Returns
+            ///
+            /// The keys necessary to trigger the `Command`, as well as the `Command` itself.
+            /// This is a key-value pair which will be stored in the `KeyMap`.
             pub fn action(self) -> (($crate::config::key::KeySequence, $crate::config::key::KeyMods), Command) {
                 match self {
                     $(