From d6314a623f79b24996633fb5e78d60604847af97 Mon Sep 17 00:00:00 2001 From: Ian Douglas Scott Date: Wed, 18 Dec 2024 12:12:05 -0800 Subject: [PATCH] Fix `cargo doc` warnings (including a couple broken links) --- src/activation.rs | 2 +- src/compositor.rs | 4 ++-- src/output.rs | 2 +- src/registry.rs | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/activation.rs b/src/activation.rs index 09b350aeb..69914f031 100644 --- a/src/activation.rs +++ b/src/activation.rs @@ -106,7 +106,7 @@ impl ActivationState { /// Request a token for surface activation with user data. /// - /// To use this method you need to provide [`delegate_activation`] with your custom type. + /// To use this method you need to provide [`delegate_activation`][crate::delegate_activation] with your custom type. /// E.g. `delegate_activation!(SimpleWindow, MyRequestData);` pub fn request_token_with_data(&self, qh: &QueueHandle, request_data: R) where diff --git a/src/compositor.rs b/src/compositor.rs index a8bfd8224..73222ebd5 100644 --- a/src/compositor.rs +++ b/src/compositor.rs @@ -134,7 +134,7 @@ impl CompositorState { } } -/// Data associated with a [`WlSurface`](wl_surface::WlSurface). +/// Data associated with a [`WlSurface`]. #[derive(Debug)] pub struct SurfaceData { /// The scale factor of the output with the highest scale factor. @@ -207,7 +207,7 @@ impl Default for SurfaceDataInner { } } -/// An owned [`WlSurface`](wl_surface::WlSurface). +/// An owned [`WlSurface`]. /// /// This destroys the surface on drop. #[derive(Debug)] diff --git a/src/output.rs b/src/output.rs index 6fd082fd4..c2dc47446 100644 --- a/src/output.rs +++ b/src/output.rs @@ -55,7 +55,7 @@ pub trait OutputHandler: Sized { type ScaleWatcherFn = dyn Fn(&mut dyn Any, &Connection, &dyn Any, &wl_output::WlOutput) + Send + Sync; -/// A handler for delegating [`wl_output::WlOutput`](wayland_client::protocol::wl_output::WlOutput). +/// A handler for delegating [`wl_output::WlOutput`]. /// /// When implementing [`ProvidesRegistryState`], /// [`registry_handlers!`](crate::registry_handlers) may be used to delegate all diff --git a/src/registry.rs b/src/registry.rs index 53fb4785e..d29f6e8ca 100644 --- a/src/registry.rs +++ b/src/registry.rs @@ -511,7 +511,7 @@ macro_rules! delegate_simple { /// A helper macro for implementing [`ProvidesRegistryState`]. /// -/// See [`delegate_registry`] for an example. +/// See [`delegate_registry`][crate::delegate_registry] for an example. #[macro_export] macro_rules! registry_handlers { ($(@<$( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+>)? $($ty:ty),* $(,)?) => {