From 849856d652e42e41fad51215af6d930f2dbaf834 Mon Sep 17 00:00:00 2001
From: Jeroen Gardeyn <jeroen.gardeyn@hotmail.com>
Date: Wed, 4 Dec 2024 17:14:57 +0100
Subject: [PATCH] improved docs

---
 jagua-rs/src/geometry/primitives/aa_rectangle.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/jagua-rs/src/geometry/primitives/aa_rectangle.rs b/jagua-rs/src/geometry/primitives/aa_rectangle.rs
index eb0ed8c..fdcaf80 100644
--- a/jagua-rs/src/geometry/primitives/aa_rectangle.rs
+++ b/jagua-rs/src/geometry/primitives/aa_rectangle.rs
@@ -34,18 +34,22 @@ impl AARectangle {
         }
     }
 
+    /// Returns the top-edge along y_max
     pub fn top_edge(&self) -> Edge {
         Edge::new(Point(self.x_max, self.y_max), Point(self.x_min, self.y_max))
     }
 
+    /// Returns the bottom-edge along y_min
     pub fn bottom_edge(&self) -> Edge {
         Edge::new(Point(self.x_min, self.y_min), Point(self.x_max, self.y_min))
     }
 
+    /// Returns the left-edge along x_min
     pub fn left_edge(&self) -> Edge {
         Edge::new(Point(self.x_min, self.y_max), Point(self.x_min, self.y_min))
     }
 
+    /// Returns the right-edge along x_max
     pub fn right_edge(&self) -> Edge {
         Edge::new(Point(self.x_max, self.y_min), Point(self.x_max, self.y_max))
     }