From 1dd79c57db6e525cfc500564b6da31388f208272 Mon Sep 17 00:00:00 2001
From: Sara <sara@saragerretsen.nl>
Date: Wed, 29 May 2024 17:36:44 +0200
Subject: [PATCH] chore: doxygen documentation for level3d

---
 level.hpp | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/level.hpp b/level.hpp
index 4f614d1..84c5cb7 100644
--- a/level.hpp
+++ b/level.hpp
@@ -7,6 +7,10 @@
 namespace gd = godot;
 
 namespace utils {
+/*! 3D level root to be used with GameRoot3D.
+ *
+ * The configured game mode will become the active GameMode in GameRoot3D if one does not exist yet.
+ */
 class Level3D : public gd::Node3D {
     GDCLASS(Level3D, gd::Node3D);
     static void _bind_methods();
@@ -14,7 +18,7 @@ public:
     void set_game_mode_prototype(gd::Ref<GameMode> prototype);
     gd::Ref<GameMode> get_game_mode_prototype() const;
 private:
-    gd::Ref<GameMode> game_mode_prototype{};
+    gd::Ref<GameMode> game_mode_prototype{}; //!< The starting state of the game mode to instantiate if this is the "leading" level.
 };
 }