space: documentation fixes

Co-authored-by: Victor Berger <vberger@users.noreply.github.com>
This commit is contained in:
Victoria Brekenfeld 2022-01-06 00:26:14 +01:00 committed by GitHub
parent 811421cd19
commit 75c84796f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 7 additions and 9 deletions

View File

@ -307,7 +307,7 @@ impl Hash for LayerSurface {
} }
#[derive(Debug)] #[derive(Debug)]
pub struct LayerSurfaceInner { pub(crate) struct LayerSurfaceInner {
pub(crate) id: usize, pub(crate) id: usize,
surface: WlrLayerSurface, surface: WlrLayerSurface,
namespace: String, namespace: String,

View File

@ -2,7 +2,7 @@
//! //!
//! This module contains helpers to organize and interact with desktop-style shells. //! This module contains helpers to organize and interact with desktop-style shells.
//! //!
//! It is therefor a lot more opinionate then for example the [xdg-shell handler](crate::wayland::shell::xdg::xdg_shell_init) //! It is therefore a lot more opinionated than for example the [xdg-shell handler](crate::wayland::shell::xdg::xdg_shell_init)
//! and tightly integrates with some protocols (e.g. xdg-shell). //! and tightly integrates with some protocols (e.g. xdg-shell).
//! //!
//! The usage of this module is therefor entirely optional and depending on your use-case you might also only want //! The usage of this module is therefor entirely optional and depending on your use-case you might also only want
@ -12,7 +12,7 @@
//! //!
//! ### [`Window`] //! ### [`Window`]
//! //!
//! A window represents what is by the user typically understood as a single application window. //! A window represents what is typically understood by the end-user as a single application window.
//! //!
//! Currently it abstracts over xdg-shell toplevels and Xwayland surfaces (TODO). //! Currently it abstracts over xdg-shell toplevels and Xwayland surfaces (TODO).
//! It provides a bunch of methods to calculate and retrieve its size, manage itself, attach additional user_data //! It provides a bunch of methods to calculate and retrieve its size, manage itself, attach additional user_data
@ -45,9 +45,9 @@
//! //!
//! ## Remarks //! ## Remarks
//! //!
//! Note that the desktop abstractions are concerned with easing rendering different clients and therefor need to be able //! Note that the desktop abstractions are concerned with easing rendering different clients and therefore need to be able
//! to manage client buffers to do so. If you plan to use the provided drawing functions, you need to use //! to manage client buffers to do so. If you plan to use the provided drawing functions, you need to use
//! [`crate::backend::renderer::utils::on_commit_buffer_handler`]. //! [`on_commit_buffer_handler`](crate::backend::renderer::utils::on_commit_buffer_handler).
pub(crate) mod layer; pub(crate) mod layer;
mod popup; mod popup;

View File

@ -43,9 +43,7 @@ impl PopupManager {
if let Some(i) = self if let Some(i) = self
.unmapped_popups .unmapped_popups
.iter() .iter()
.enumerate() .position(|p| p.get_surface() == Some(surface))
.find(|(_, p)| p.get_surface() == Some(surface))
.map(|(i, _)| i)
{ {
slog::trace!(self.logger, "Popup got mapped"); slog::trace!(self.logger, "Popup got mapped");
let popup = self.unmapped_popups.swap_remove(i); let popup = self.unmapped_popups.swap_remove(i);

View File

@ -112,7 +112,7 @@ impl Space {
} }
} }
/// Unmap a [`Window`] from this space by. /// Unmap a [`Window`] from this space.
/// ///
/// This function does nothing for already unmapped windows /// This function does nothing for already unmapped windows
pub fn unmap_window(&mut self, window: &Window) { pub fn unmap_window(&mut self, window: &Window) {