documentation cleanup

4 files changed, 16 insertions, 4 deletions

diff --git a/src/clients/client.rs b/src/clients/client.rs
index 3b33b5f..394c319 100644
--- a/src/clients/client.rs
+++ b/src/clients/client.rs
@@ -133,7 +133,7 @@ impl Client {
 
     /// Sync the non-geometry related properties with EWMH hints
     pub fn sync_properties(&mut self, conn: &Connection<'_>, focused: bool) {
-        let Some(mut hints) = hints::Xwm::get(conn, self.window) else {
+        let Some(mut hints) = hints::Ewm::get(conn, self.window) else {
             return;
         };
 
diff --git a/src/clients/hints.rs b/src/clients/hints.rs
index dd5bcf7..bd3ef76 100644
--- a/src/clients/hints.rs
+++ b/src/clients/hints.rs
@@ -5,7 +5,8 @@ use xcb::{
 
 use crate::conn_info::Connection;
 
-pub struct Xwm {
+/// EWM Hints set on a window.
+pub struct Ewm {
     flags: u32,
     input: bool,
     initial_state: i32,
@@ -17,7 +18,7 @@ pub struct Xwm {
     window_group: u32,
 }
 
-impl Xwm {
+impl Ewm {
     /// Get the EWM hints for the given window, if they exist and are valid.
     pub fn get(conn: &Connection<'_>, window: Window) -> Option<Self> {
         // https://github.com/mirror/libX11/blob/ff8706a5eae25b8bafce300527079f68a201d27f/src/GetHints.c#L106
diff --git a/src/clients/mod.rs b/src/clients/mod.rs
index c7df881..ca9ed91 100644
--- a/src/clients/mod.rs
+++ b/src/clients/mod.rs
@@ -1,3 +1,5 @@
+//! Tracking and managing windows.
+
 use crate::{
     config::BORDER_WIDTH,
     conn_info::Connection,
@@ -14,12 +16,19 @@ use xcb::{
     BaseEvent, Extension,
 };
 
-pub use client::Client;
+pub use client::*;
+pub use hints::*;
 pub use monitors::*;
 
+#[doc(hidden)]
 mod client;
+
+#[doc(hidden)]
 mod hints;
+
+#[doc(hidden)]
 mod monitors;
+
 mod tile;
 
 impl WM<'_> {
diff --git a/src/clients/tile.rs b/src/clients/tile.rs
index 4a2d4fc..e089c3f 100644
--- a/src/clients/tile.rs
+++ b/src/clients/tile.rs
@@ -1,3 +1,5 @@
+//! Tiling functions
+
 use std::cmp::min;
 
 use crate::conn_info::Connection;