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 redundant/broken intradoc links and minor cleanup #716

Merged
merged 13 commits into from
May 20, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Turn mention of inexistant from_external_display() into proper doc-…
…link
  • Loading branch information
MarijnS95 committed May 14, 2024
commit 620f99a1cede9f2d8f3608bd8be3dda3a138d0bd
11 changes: 6 additions & 5 deletions wayland-client/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,12 @@
//! - If you need to send pointers to FFI, you can retrive the `*mut wl_proxy` pointers from the proxies by
//! first getting the [`ObjectId`](crate::backend::ObjectId) using the [`Proxy::id()`] method, and then
//! using the `ObjectId::as_ptr()` method.
//! - If you need to receive pointers from FFI, you need to first create a
//! [`Backend`](crate::backend::Backend) from the `*mut wl_display` using the `from_external_display()`
//! method (see `wayland-backend` docs), and then make it into a [`Connection`] using
//! [`Connection::from_backend()`]. Similarly, you can make [`ObjectId`]s from the `*mut wl_proxy` pointers
//! using `ObjectId::from_ptr()`, and then make the proxies using [`Proxy::from_id`].
// - If you need to receive pointers from FFI, you need to first create a
// [`Backend`][backend::Backend] from the `*mut wl_display` using
// [`Backend::from_external_display()`][backend::Backend::from_foreign_display()], and then
// make it into a [`Connection`] using [`Connection::from_backend()`]. Similarly, you can make
// [`ObjectId`]s from the `*mut wl_proxy` pointers using [`ObjectId::from_ptr()`], and then make
// the proxies using [`Proxy::from_id()`].

#![allow(clippy::needless_doctest_main)]
#![warn(missing_docs, missing_debug_implementations)]
Expand Down