Add documentation

src/backend/udev.rs

@@ -1,3 +1,6 @@
+// from anvil
+// TODO: figure out what this stuff does
+
 use std::{
     collections::{HashMap, HashSet},
     error::Error,

src/main.rs

@@ -1,11 +1,11 @@
-#![warn(missing_docs)] // pretty sure this only warns the main file because nothing else is public
+#![warn(missing_docs)] // pretty sure this only warns in the main file because nothing else is public
 
 //! A very, VERY WIP Smithay-based Wayland compositor.
 //!
 //! Pinnacle is heavily inspired by the [Awesome Window Manager](https://awesomewm.org),
 //! and this is an attempt to make something akin to it for Wayland.
 //!
-//! While Pinnacle is not a library, this documentation serves to guide those who would like to
+//! While Pinnacle is not a library, this documentation serves to guide those who want to
 //! contribute or learn how building something like this works.
 
 mod api;

src/state.rs

@@ -412,6 +412,7 @@ pub struct SurfaceDmabufFeedback<'a> {
     pub scanout_feedback: &'a DmabufFeedback,
 }
 
+// TODO: docs
 pub fn take_presentation_feedback(
     output: &Output,
     space: &Space<Window>,
@@ -444,6 +445,7 @@ pub fn take_presentation_feedback(
     output_presentation_feedback
 }
 
+/// State containing the config API's stream.
 #[derive(Default)]
 pub struct ApiState {
     pub stream: Option<Arc<Mutex<UnixStream>>>,