Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix cargo doc warnings (including a couple broken links) #483

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/activation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<D, R>(&self, qh: &QueueHandle<D>, request_data: R)
where
Expand Down
4 changes: 2 additions & 2 deletions src/compositor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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)]
Expand Down
2 changes: 1 addition & 1 deletion src/output.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/registry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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),* $(,)?) => {
Expand Down
Loading