doxygen comment colliders

2 files changed, 17 insertions, 0 deletions

diff --git a/src/crepe/api/BoxCollider.h b/src/crepe/api/BoxCollider.h
index 357c979..7f51cba 100644
--- a/src/crepe/api/BoxCollider.h
+++ b/src/crepe/api/BoxCollider.h
@@ -5,10 +5,19 @@
 
 namespace crepe {
 
+/**
+ * \brief A class representing a box-shaped collider.
+ * 
+ * This class is used for collision detection with other colliders (e.g., CircleCollider).
+ */
 class BoxCollider : public Collider {
 public:
 	BoxCollider(game_object_id_t game_object_id,Vector2 offset, double width, double height);
+
+	//! Width of box collider 
 	double width;
+
+	//! Height of box collider
 	double height;
 };
 
diff --git a/src/crepe/api/CircleCollider.h b/src/crepe/api/CircleCollider.h
index 29a9c1e..4e04fa4 100644
--- a/src/crepe/api/CircleCollider.h
+++ b/src/crepe/api/CircleCollider.h
@@ -6,9 +6,17 @@
 
 namespace crepe {
 
+/**
+ * \brief A class representing a circle-shaped collider.
+ * 
+ * This class is used for collision detection with other colliders (e.g., BoxCollider).
+ */
 class CircleCollider : public Collider {
 public:
+
 	CircleCollider(game_object_id_t game_object_id,Vector2 offset, int radius);
+
+	//! Radius of the circle collider.
 	double radius;
 };