From 161ed77f4d7287a9f41d300fbdd27d2296f772e7 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Sat, 31 Oct 2026 23:53:18 -0700 Subject: [PATCH] docs(kde): fix the intra-doc links that cargo doc -D warnings rejects The kfde doc check failed (rustdoc exit 101) on eleven links: Backend::hide, restore, cursor_pos, set_rect, focus, center_cursor_in, current_workspaces and window_workspace are not items of the trait Backend that the links resolve to here, [`Window`] and [`TRANSPARENCY_ALPHA`] are not in scope in their modules, and the public Workspace alias links to the private WorkspaceScrolling. The brackets are removed (the names stay as code), and the two link definitions in desktop.rs. Documentation text only, no code change. Verified: RUSTDOCFLAGS='-D warnings' cargo doc --locked -p komorebi -p komorebi-linux -p komorebic -p komorebi-client -p komorebi-hotkeys --no-deps (the flake's package set) finishes without errors, before it reproduced exactly these eleven; local stable rustc is 1.99.1, the toolchain of the flake. --- komorebi-for-kde/komorebi/src/desktop.rs | 7 ++----- komorebi-for-kde/komorebi/src/kwin/mod.rs | 10 +++++----- komorebi-for-kde/komorebi/src/monitor.rs | 2 +- komorebi-for-kde/komorebi/src/transparency_manager.rs | 2 +- komorebi-for-kde/komorebi/src/workspace.rs | 2 +- 5 files changed, 10 insertions(+), 13 deletions(-) diff --git a/komorebi-for-kde/komorebi/src/desktop.rs b/komorebi-for-kde/komorebi/src/desktop.rs index 261efe5f..d92701b2 100644 --- a/komorebi-for-kde/komorebi/src/desktop.rs +++ b/komorebi-for-kde/komorebi/src/desktop.rs @@ -286,8 +286,8 @@ pub fn update_monitor_work_areas(wm: &mut WindowManager) -> eyre::Result<()> { /// are on, so that starting komorebi tiles what is on screen. /// /// Each monitor is first focused on the workspace the compositor shows on it -/// ([`Backend::current_workspaces`]). A window is on the monitor whose bounds contain its middle, -/// and on the workspace whose desktop it is on ([`Backend::window_workspace`]), which need not be +/// (`Backend::current_workspaces`). A window is on the monitor whose bounds contain its middle, +/// and on the workspace whose desktop it is on (`Backend::window_workspace`), which need not be /// the one in front; a window on every desktop goes to the one in front. The monitor gets as many /// workspaces as that takes. A window that is minimized, that komorebi does not manage /// ([`Window::should_manage`]: not a normal window, or one the rules ignore), or that is on no @@ -295,9 +295,6 @@ pub fn update_monitor_work_areas(wm: &mut WindowManager) -> eyre::Result<()> { /// ([`Workspace::adopt_maximized_window`](crate::workspace::Workspace::adopt_maximized_window)), not /// a container. Nothing is moved: tiling is [`WindowManager::retile_all`]'s job. /// -/// [`Backend::current_workspaces`]: crate::backend::Backend::current_workspaces -/// [`Backend::window_workspace`]: crate::backend::Backend::window_workspace -/// /// # Errors /// /// This never returns an error: a window that cannot be placed is skipped. diff --git a/komorebi-for-kde/komorebi/src/kwin/mod.rs b/komorebi-for-kde/komorebi/src/kwin/mod.rs index 468b7b7b..d06e6d25 100644 --- a/komorebi-for-kde/komorebi/src/kwin/mod.rs +++ b/komorebi-for-kde/komorebi/src/kwin/mod.rs @@ -52,8 +52,8 @@ //! When something other than komorebi does either, the script reports it, and the table turns it //! into a [`WorkspaceChange`] or a [`WorkspaceMove`] for the window manager to follow. //! -//! Hiding a window ([`Backend::hide`]) moves it to one more desktop, `komorebi-park`, that nobody -//! looks at and that is not a workspace; [`Backend::restore`] moves it back to the desktop of its +//! Hiding a window (`Backend::hide`) moves it to one more desktop, `komorebi-park`, that nobody +//! looks at and that is not a workspace; `Backend::restore` moves it back to the desktop of its //! workspace. KWin saves its desktops in `kwinrc` as soon as one is made, so a desktop that //! komorebi made and did not remove would be there for every later session: komorebi removes it //! when it stops, and one that an earlier run left (it was killed, or the session was torn down @@ -304,12 +304,12 @@ impl Poll { /// The desktop of a running KWin, read and changed through the script komorebi loads into it. /// /// The queries are answered from a [`state::Table`] that the script's events keep up to date, so -/// they do not wait for KWin, except [`Backend::cursor_pos`]: only the script can read the pointer, +/// they do not wait for KWin, except `Backend::cursor_pos`: only the script can read the pointer, /// so it is asked, and given 250 ms to answer. The table also keeps the frame a window had when the /// user began to drag it, for [`Backend::drag_origin`], and the frame the user asked for when they /// let go of an edge of it, for [`Backend::drag_end`]. /// -/// A command ([`Backend::set_rect`], [`Backend::focus`] and the rest) is queued for the script and +/// A command (`Backend::set_rect`, `Backend::focus` and the rest) is queued for the script and /// returns: the script gets the queue as the answer to its held `Poll` call, and carries the /// commands out in order. Commands queued within a millisecond of each other go out as one batch, /// so a retile reaches KWin at once. A command is an error when the table does not know the @@ -318,7 +318,7 @@ impl Poll { /// /// The script cannot move the pointer, so the pointer follows the focus through KWin's own "Move /// Mouse to Focus" action, over `kglobalaccel`: it lands in the middle of the window KWin has -/// focused, whatever rectangle [`Backend::center_cursor_in`] is given. A KWin without global +/// focused, whatever rectangle `Backend::center_cursor_in` is given. A KWin without global /// shortcuts leaves the pointer where it is. /// /// It is made by [`connect`]. diff --git a/komorebi-for-kde/komorebi/src/monitor.rs b/komorebi-for-kde/komorebi/src/monitor.rs index 44d052bb..fade41a6 100644 --- a/komorebi-for-kde/komorebi/src/monitor.rs +++ b/komorebi-for-kde/komorebi/src/monitor.rs @@ -34,7 +34,7 @@ use serde::Deserialize; use serde::Serialize; use std::sync::atomic::Ordering; -/// The monitor over KDE's [`Window`], which is `komorebi_core::Monitor` with this platform's methods +/// The monitor over KDE's `Window`, which is `komorebi_core::Monitor` with this platform's methods /// added by [`MonitorExt`] pub type Monitor = komorebi_core::Monitor; diff --git a/komorebi-for-kde/komorebi/src/transparency_manager.rs b/komorebi-for-kde/komorebi/src/transparency_manager.rs index 7e6f2ffe..97bcce78 100644 --- a/komorebi-for-kde/komorebi/src/transparency_manager.rs +++ b/komorebi-for-kde/komorebi/src/transparency_manager.rs @@ -98,7 +98,7 @@ pub fn transparent_windows(wm: &WindowManager) -> Vec { /// /// The backend is told only what differs from what it was last told, which the window manager /// keeps in [`WindowManager::opacity_applied`]: windows that should not be see-through any more -/// are made opaque, and the others are given [`TRANSPARENCY_ALPHA`]. With transparency off, every +/// are made opaque, and the others are given `TRANSPARENCY_ALPHA`. With transparency off, every /// window is opaque. A failure is logged. pub fn apply(wm: &mut WindowManager) { // one snapshot, so the flag and the alpha are from the same configuration diff --git a/komorebi-for-kde/komorebi/src/workspace.rs b/komorebi-for-kde/komorebi/src/workspace.rs index 751aea0d..01f42e1a 100644 --- a/komorebi-for-kde/komorebi/src/workspace.rs +++ b/komorebi-for-kde/komorebi/src/workspace.rs @@ -43,7 +43,7 @@ pub use komorebi_core::WorkspaceWindowLocation; pub(crate) use komorebi_core::sorted_layout_options_rules; /// The workspace over KDE's [`Window`], which is `komorebi_core::Workspace` with this platform's -/// methods added by [`WorkspaceExt`] and the scrolling ones of [`WorkspaceScrolling`] +/// methods added by [`WorkspaceExt`] and the scrolling ones of `WorkspaceScrolling` pub type Workspace = komorebi_core::Workspace; /// What only KDE keeps in a workspace