docs: add some rustdoc comments throughout

src/sway/node.rs

@@ -3,6 +3,9 @@ use color_eyre::Result;
 use ksway::IpcCommand;
 
 impl SwayNode {
+    /// Gets either the `app_id` or `class`
+    /// depending on whether this is a native Wayland
+    /// or xwayland application.
     pub fn get_id(&self) -> &str {
         self.app_id.as_ref().map_or_else(
             || {
@@ -17,11 +20,15 @@ impl SwayNode {
         )
     }
 
+    /// Checks whether this application
+    /// is running under xwayland.
     pub fn is_xwayland(&self) -> bool {
         self.shell == Some(String::from("xwayland"))
     }
 }
 
+/// Recursively checks the provided node for any child application nodes.
+/// Returns a list of any found application nodes.
 fn check_node(node: SwayNode, window_nodes: &mut Vec<SwayNode>) {
     if node.name.is_some() && (node.node_type == "con" || node.node_type == "floating_con") {
         window_nodes.push(node);
@@ -37,6 +44,7 @@ fn check_node(node: SwayNode, window_nodes: &mut Vec<SwayNode>) {
 }
 
 impl SwayClient {
+    /// Gets a flat vector of all currently open windows.
     pub fn get_open_windows(&mut self) -> Result<Vec<SwayNode>> {
         let root_node = self.ipc(IpcCommand::GetTree)?;
         let root_node = serde_json::from_slice(&root_node)?;