From b6141f6cbf07f0fbfadc892488f2ba83b7cf1719 Mon Sep 17 00:00:00 2001
From: Clyne Sullivan <tullivan99@gmail.com>
Date: Sat, 10 Dec 2016 18:33:40 -0500
Subject: doc updates

---
 include/engine.hpp | 63 ++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 56 insertions(+), 7 deletions(-)

(limited to 'include/engine.hpp')

diff --git a/include/engine.hpp b/include/engine.hpp
index c842b59..d4028d8 100644
--- a/include/engine.hpp
+++ b/include/engine.hpp
@@ -1,8 +1,13 @@
+/**
+ * @file engine.hpp
+ * @brief The main game engine, and functions to assist it.
+ */
+
 #ifndef ENGINE_HPP_
 #define ENGINE_HPP_
 
 #include <entityx/entityx.h>
-#include "entityx/deps/Dependencies.h"
+#include <entityx/deps/Dependencies.h>
 
 #include <texture.hpp>
 #include <components.hpp>
@@ -10,27 +15,55 @@
 
 //game::engine::Systems->add<entityx::deps::Dependency<Visible, Sprite>>();
 
+/**
+ * @class Engine
+ * The main game engine class. Only one instance of this should be created, it
+ * handles everything game-related.
+ */
 class Engine : public entityx::Receiver<Engine> {
 public:
+	/**
+	 * A flag to indicate if a thread should continue to run.
+	 */
 	bool shouldRun;
 
+	/**
+	 * Handles game systems.
+	 */
     entityx::SystemManager systems;
 
 	explicit Engine(void);
 
+	/**
+	 * Initializes the game engine, and all systems used within it.
+	 */
 	void init(void);
+
+	/**
+	 * Updates all rendering systems.
+	 * @param dt the delta time
+	 */
     void render(entityx::TimeDelta dt);
+
+	/**
+	 * Updates all logic systems.
+	 * @param dt the delta time
+	 */
 	void update(entityx::TimeDelta dt);
 
+	/**
+	 * A shortcut to get a system, for calling system-specific functions.
+	 * Takes the type of the desired system.
+	 */
 	template<typename T>
 	inline T* getSystem(void) {
 		return dynamic_cast<T*>(systems.system<T>().get());
 	}
 
-	/*void configure(entityx::EventManager &ev) {
-		(void)ev;
-	}*/
-
+	/**
+	 * A handler for the game ending event.
+	 * @param gee game end event data
+	 */
 	inline void receive(const GameEndEvent &gee) {
 		shouldRun = !(gee.really);
 	}
@@ -38,16 +71,32 @@ public:
 
 
 namespace game {
+	/**
+	 * Handles all game events.
+	 */
 	extern entityx::EventManager events;
+
+	/**
+	 * Handles entity data.
+	 */
     extern entityx::EntityManager entities;
 
+	/**
+	 * Handles sprite loading, for the sprite system.
+	 */
+	extern SpriteLoader sprite_l;
+
+	/**
+	 * An instance of the main game engine.
+	 */
     extern Engine engine;
 
+	/**
+	 * Ends the game.
+	 */
     inline void endGame(void) {
         events.emit<GameEndEvent>();
     }
-
-	extern SpriteLoader sprite_l;
 }
 
 
-- 
cgit v1.2.3