From 8ee08ef6f20034d1b691a9eb963b8636cf092b72 Mon Sep 17 00:00:00 2001 From: Victor Berger Date: Sun, 1 Oct 2017 21:58:24 +0200 Subject: [PATCH] wayland: document general behaviour of the client handlers --- src/wayland/mod.rs | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/wayland/mod.rs b/src/wayland/mod.rs index aa808ce32ea6..ccdb2d97af51 100644 --- a/src/wayland/mod.rs +++ b/src/wayland/mod.rs @@ -2,6 +2,21 @@ //! //! This module contains several handlers to manage the wayland protocol //! and the clients. +//! +//! Most utilities provided in this module work in the wame way: +//! +//! - An init function or method will take the event loop as argument and +//! insert one or more globals into it. +//! - These functions will return the `Global` handles and, if applicable, +//! a `StateToken` allowing you to access the associated state value in +//! this event loop. +//! - If you want to remove a previously inserted global, just call the +//! `destroy()` method on the associated `Global`. If you don't plan to +//! destroy the global at all, you don't need to bother keeping the +//! `Global` around. +//! - You should not remove a state value from the event loop if you have +//! not previously destroyed all the globals using it, otherwise you'll +//! quickly encounter a panic. pub mod compositor; pub mod output;