diff options
| -rw-r--r-- | src/buttons.rs | 2 | ||||
| -rw-r--r-- | src/helpers.rs | 6 | ||||
| -rw-r--r-- | src/log.rs | 2 | ||||
| -rw-r--r-- | src/main.rs | 1 |
4 files changed, 6 insertions, 5 deletions
diff --git a/src/buttons.rs b/src/buttons.rs index da6c9c2..fc79fa6 100644 --- a/src/buttons.rs +++ b/src/buttons.rs @@ -196,7 +196,7 @@ pub struct ButtonBind { pub action: &'static dyn Fn(&mut WM<'_>), } -/// A set of button binds. Currently, there is only one instance of this defined statically: [`crate::config::BUTTONBINDS`]. +/// A set of button binds. Currently, there is only one instance of this defined statically: [`crate::config::BUTTON_BINDS`]. pub struct ButtonBinds(pub &'static [ButtonBind]); impl ButtonBinds { diff --git a/src/helpers.rs b/src/helpers.rs index e67aecc..5a2844d 100644 --- a/src/helpers.rs +++ b/src/helpers.rs @@ -6,7 +6,7 @@ use crate::{ }; use std::{ffi::OsStr, process::Command}; -/// Syntax sugar for creating [`Keybind`]s. This is helpful for writing [`crate::config::KEYBINDS`] +/// Syntax sugar for creating [`Keybind`](`crate::keys::Keybind`)s. This is helpful for writing [`crate::config::KEYBINDS`] /// /// ```rust /// /// Control + Shift + t prints "It Works!" @@ -23,7 +23,7 @@ macro_rules! bind { }; } -/// Syntax sugar for creating [`ButtonBind`]s. See also: [`self::bind`]. +/// Syntax sugar for creating [`ButtonBind`](`crate::buttons::ButtonBind`)s. See also: [`crate::bind`]. #[macro_export] macro_rules! bind_btn { ($mod:expr , $key:ident -> $action:expr) => { @@ -35,7 +35,7 @@ macro_rules! bind_btn { }; } -/// Execute the given command with arguments, disowning the process. +/// Execute the given command with arguments. pub fn spawn<I, S>(cmd: &str, args: I) where I: IntoIterator<Item = S>, @@ -1,6 +1,6 @@ //! Helper macros for logging -/// Log to standard error, only compiled when in debug mode. +/// Log to standard error when `debug_assertions` are on #[macro_export] macro_rules! debug { ($($e:expr),*) => { diff --git a/src/main.rs b/src/main.rs index 1f98801..f2ad91b 100644 --- a/src/main.rs +++ b/src/main.rs @@ -45,6 +45,7 @@ pub mod helpers; pub mod keys; pub mod log; +/// Do the thing! fn main() -> Result<()> { cleanup_process_children(); |