Added Doxygen comments/explanation for GameObjects and Scenes

1 files changed, 14 insertions, 0 deletions

diff --git a/src/crepe/api/Scene.h b/src/crepe/api/Scene.h
index 0e516b6..6647135 100644
--- a/src/crepe/api/Scene.h
+++ b/src/crepe/api/Scene.h
@@ -7,19 +7,33 @@ namespace crepe {
 class SceneManager;
 class ComponentManager;
 
+/**
+ * \brief Represents a Scene
+ * 
+ * This class represents a Scene. The Scene class is only used as an interface for the game
+ * programmer.
+ */
 class Scene {
 protected:
+	/**
+	 * \param mgr  Reference to the ComponentManager
+	 * \param name  Name of the scene
+	 */
 	Scene(ComponentManager & mgr, const std::string & name);
+	//! SceneManager instances Scene
 	friend class SceneManager;
 
 public:
 	virtual ~Scene() = default;
 
 public:
+	//! Load the scene
 	virtual void load_scene() = 0;
+	//! The scene name
 	const std::string name;
 
 protected:
+	//! Reference to the ComponentManager
 	ComponentManager & component_manager;
 };