Document Vec2 constants

emilk · Jul 5, 2024 · f92fe55 · f92fe55
1 parent 0a9e0c8
commit f92fe55
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/crates/emath/src/vec2.rs b/crates/emath/src/vec2.rs
@@ -121,12 +121,22 @@ impl From<Vec2> for mint::Vector2<f32> {
 // ----------------------------------------------------------------------------
 
 impl Vec2 {
+    /// Right
     pub const X: Self = Self { x: 1.0, y: 0.0 };
+
+    /// Down
     pub const Y: Self = Self { x: 0.0, y: 1.0 };
 
+    /// +X
     pub const RIGHT: Self = Self { x: 1.0, y: 0.0 };
+
+    /// -X
     pub const LEFT: Self = Self { x: -1.0, y: 0.0 };
+
+    /// -Y
     pub const UP: Self = Self { x: 0.0, y: -1.0 };
+
+    /// +Y
     pub const DOWN: Self = Self { x: 0.0, y: 1.0 };
 
     pub const ZERO: Self = Self { x: 0.0, y: 0.0 };