From 124e6878b1de561f4bc3fccea768203821c88469 Mon Sep 17 00:00:00 2001
From: tcmal <me@aria.rip>
Date: Sun, 9 Jun 2024 17:34:45 +0100
Subject: minor cleanup

---
 src/colours.rs | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src/colours.rs')

diff --git a/src/colours.rs b/src/colours.rs
index 6f862c3..bab92b6 100644
--- a/src/colours.rs
+++ b/src/colours.rs
@@ -4,14 +4,18 @@ use xcb::{
     Connection,
 };
 
+/// Caches colours in an X11 color map.
 pub struct Colours {
+    #[allow(unused)] // Make sure the colour map we're using doesn't go anywhere
     cmap: Colormap,
     border_normal: u32,
     border_focused: u32,
 }
 
 impl Colours {
+    /// Load the colours into the given colour map
     pub fn new_with(conn: &Connection, cmap: Colormap) -> Result<Self> {
+        // TODO: Move these colours out to config.rs
         let (border_normal, border_focused) = (
             conn.wait_for_reply(conn.send_request(&AllocColor {
                 cmap,
@@ -34,10 +38,12 @@ impl Colours {
         })
     }
 
+    /// Get the pixel ID of the colour for an unfocused window's border.
     pub fn border_normal(&self) -> u32 {
         self.border_normal
     }
 
+    /// Get the pixel ID of the colour for a focused window's border.
     pub fn border_focused(&self) -> u32 {
         self.border_focused
     }
-- 
cgit v1.2.3