docs: use doc-comments

Some basic cleanup of the code before it is refactored for Pathy 2.

.direnv/flake-profile

@@ -1 +1 @@
-flake-profile-1-link
+flake-profile-4-link

.direnv/flake-profile-4-link

@@ -0,0 +1 @@
+/nix/store/6wvzz0b0zd6gagdww6s8241zsv21z50g-nix-shell-env

flake.nix

@@ -13,13 +13,24 @@
           inherit system;
         };
       in {
-        devShells.default = pkgs.mkShell {
+        devShells.default = pkgs.mkShell rec {
           # Additional dev-shell environment variables can be set directly
           # MY_CUSTOM_DEVELOPMENT_VAR = "something else";
 
           nativeBuildInputs = with pkgs; [
             trunk
+            rust-analyzer
           ];
+          buildInputs = with pkgs; [
+            libxkbcommon
+            libGL
+            xorg.libX11
+            wayland
+            xorg.libXrandr
+            xorg.libXcursor
+            xorg.libXi
+          ];
+          LD_LIBRARY_PATH = "${pkgs.lib.makeLibraryPath buildInputs}";
         };
       });
 }

src/app.rs

@@ -27,11 +27,14 @@ macro_rules! console_log {
     ($($t:tt)*) => (log(&format_args!($($t)*).to_string()))
 }
 // */
+
 #[derive(serde::Deserialize, serde::Serialize)]
 #[serde(default)] // if we add new fields, give them default values when deserializing old state
+/// A class containing the current state of Pathy.
 pub struct PathyApp {
-    // this how you opt-out of serialization of a member
-    //#[serde(skip)]
+    // This how you opt-out of serialization of a member
+    // #[serde(skip)]
+    // This will prevent said member from being saved
     pub height: f32,             // Height of field
     pub width: f32,              // Width of field
     pub scale: f32,              // Scale to display
@@ -45,8 +48,8 @@ pub struct PathyApp {
 }
 
 #[derive(serde::Deserialize, serde::Serialize, Eq, PartialEq)]
+/// Represents possible Cursor modes
 pub enum CursorMode {
-    // Represent possible cursor modes
     Default, // No action
     Create,  // Create new nodes and paths
     Edit,    // Edit the positioning of points
@@ -55,8 +58,8 @@ pub enum CursorMode {
 }
 
 #[derive(serde::Deserialize, serde::Serialize, Clone)]
+/// Represents movements for the robot to take
 pub enum Process {
-    // Represents movements for the robot to take
     Drive(i32),
     Turn(i32),
 }