From 6812d66020ea659b3bda3ca44f7722d1c0b3564b Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Sun, 29 Oct 2023 11:14:21 +0100 Subject: [PATCH] Document some more features There were two PRs in parallel. One added some new features and the other added some explanation of features to the lib.rs files. This commit now also adds the new feature to the documentation. Signed-off-by: Uli Schlachter --- x11rb-async/src/lib.rs | 2 ++ x11rb-protocol/src/lib.rs | 3 +++ x11rb/src/lib.rs | 2 ++ 3 files changed, 7 insertions(+) diff --git a/x11rb-async/src/lib.rs b/x11rb-async/src/lib.rs index 733517d4..fbe35bc9 100644 --- a/x11rb-async/src/lib.rs +++ b/x11rb-async/src/lib.rs @@ -38,6 +38,8 @@ //! Additionally, the following flags exist: //! * `allow-unsafe-code`: Enable the same feature in x11rb and implement //! [`blocking::BlockingConnection`] for [`x11rb::xcb_ffi::XCBConnection`] +//! * `extra-traits`: Implement extra traits for X11 types. This improves the output of the `Debug` +//! impl and adds `PartialEq`, `Eq`, `PartialOrd`, `Ord`, and `Hash` where possible. // -- Public Modules -- diff --git a/x11rb-protocol/src/lib.rs b/x11rb-protocol/src/lib.rs index e71f6028..290b2fb9 100644 --- a/x11rb-protocol/src/lib.rs +++ b/x11rb-protocol/src/lib.rs @@ -36,6 +36,9 @@ //! * `resource_manager`: Enable the code in [resource_manager] for loading and querying the //! X11 resource database. //! * `serde`: Implement [`serde::Serialize`] and [`serde::Deserialize`] for all objects. +//! * `request-parsing`: Add the ability to parse X11 requests. Not normally needed. +//! * `extra-traits`: Implement extra traits for types. This improves the output of the `Debug` +//! impl and adds `PartialEq`, `Eq`, `PartialOrd`, `Ord`, and `Hash` where possible. #![forbid( missing_copy_implementations, diff --git a/x11rb/src/lib.rs b/x11rb/src/lib.rs index a2a3bbf4..72eac236 100644 --- a/x11rb/src/lib.rs +++ b/x11rb/src/lib.rs @@ -112,6 +112,8 @@ //! `Hash`. This is not needed by default and adds a large amount of code that bloats codegen //! time //! * `request-parsing`: Add the ability to parse X11 requests. Not normally needed. +//! * `extra-traits`: Implement extra traits for X11 types. This improves the output of the `Debug` +//! impl and adds `PartialEq`, `Eq`, `PartialOrd`, `Ord`, and `Hash` where possible. //! //! # Integrating x11rb with an Event Loop //!