From a779e6b5c005337e7a8d4a52f1e08605fd3a790b Mon Sep 17 00:00:00 2001
From: Victor Brekenfeld <github@drakulix.de>
Date: Thu, 6 Jan 2022 18:24:49 +0100
Subject: [PATCH] docs: Always referr to layer surfaces as such

---
 src/desktop/layer.rs | 14 +++++++-------
 src/desktop/mod.rs   |  2 +-
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/desktop/layer.rs b/src/desktop/layer.rs
index bd9f4d2..1fe34f7 100644
--- a/src/desktop/layer.rs
+++ b/src/desktop/layer.rs
@@ -97,9 +97,9 @@ impl LayerMap {
         self.zone
     }
 
-    /// Returns the geometry of a given mapped layer.
+    /// Returns the geometry of a given mapped [`LayerSurface`].
     ///
-    /// If the layer was not previously mapped onto this layer map,
+    /// If the surface was not previously mapped onto this layer map,
     /// this function return `None`.
     pub fn layer_geometry(&self, layer: &LayerSurface) -> Option<Rectangle<i32, Logical>> {
         if !self.layers.contains(layer) {
@@ -111,7 +111,7 @@ impl LayerMap {
         Some(bbox)
     }
 
-    /// Returns a `LayerSurface` under a given point and on a given layer, if any.
+    /// Returns a [`LayerSurface`] under a given point and on a given layer, if any.
     pub fn layer_under<P: Into<Point<f64, Logical>>>(
         &self,
         layer: WlrLayer,
@@ -147,9 +147,9 @@ impl LayerMap {
             .find(|w| w.get_surface().map(|x| x == surface).unwrap_or(false))
     }
 
-    /// Force re-arranging the layers, e.g. when the output size changes.
+    /// Force re-arranging the layer surfaces, e.g. when the output size changes.
     ///
-    /// Note: Mapping or unmapping a layer will automatically cause a re-arrangement.
+    /// Note: Mapping or unmapping a layer surface will automatically cause a re-arrangement.
     pub fn arrange(&mut self) {
         if let Some(output) = self.output() {
             let output_rect = Rectangle::from_loc_and_size(
@@ -401,7 +401,7 @@ impl LayerSurface {
         }
     }
 
-    /// Returns the bounding box over this layer, it subsurfaces as well as any popups.
+    /// Returns the bounding box over this layer surface, it subsurfaces as well as any popups.
     ///
     /// Note: You need to use a [`PopupManager`] to track popups, otherwise the bounding box
     /// will not include the popups.
@@ -450,7 +450,7 @@ impl LayerSurface {
         }
     }
 
-    /// Returns the damage of all the surfaces of this layer.
+    /// Returns the damage of all the surfaces of this layer surface.
     ///
     /// If `for_values` is `Some(_)` it will only return the damage on the
     /// first call for a given [`Space`] and [`Output`], if the buffer hasn't changed.
diff --git a/src/desktop/mod.rs b/src/desktop/mod.rs
index 354674d..a905e2e 100644
--- a/src/desktop/mod.rs
+++ b/src/desktop/mod.rs
@@ -28,7 +28,7 @@
 //! Windows get a position and stacking order through mapping. Outputs become views of a part of the [`Space`]
 //! and can be rendered via [`Space::render_output`]. Rendering results of spaces are automatically damage-tracked.
 //!
-//! ### Layer
+//! ### Layer Shell
 //!
 //! A [`LayerSurface`] represents a surface as provided by e.g. the layer-shell protocol.
 //! It provides similar helper methods as a [`Window`] does to toplevel surfaces.