add documentation

1 files changed, 9 insertions, 5 deletions

diff --git a/src/crepe/api/Engine.h b/src/crepe/api/Engine.h
index 5421d60..efe7853 100644
--- a/src/crepe/api/Engine.h
+++ b/src/crepe/api/Engine.h
@@ -20,13 +20,16 @@ namespace crepe {
  */
 class Engine {
 public:
-	void start();
-
 	/**
-	 * \brief Add a new concrete scene to the scene manager
+	 * \brief Engine entrypoint
+	 *
+	 * This function is called by the game programmer after registering all scenes
 	 *
-	 * \tparam T  Type of concrete scene
+	 * \returns process exit code
 	 */
+	int main() noexcept;
+
+	//! \copydoc SceneManager::add_scene
 	template <typename T>
 	void add_scene();
 
@@ -44,7 +47,8 @@ private:
 	 */
 	void loop();
 
-	bool game_running = false;
+	//! Game loop condition
+	bool game_running = true;
 
 private:
 	//! Global context