partway through some documentation and bug fixing

2018-02-17 01:08:31 -08:00
parent 176d9f7a54
commit 51be54c964
11 changed files with 146 additions and 38 deletions
--- a/include/Gui.h
+++ b/include/Gui.h
@@ -3,6 +3,19 @@
 #include <Logger.h>
 #include <list>

+/**
+ *
+ * GUI
+ *
+ * Any class that wants to have an interactive GUI rendered to the window may
+ * inherit GUI and override the render_gui() and update_gui() methods
+ *
+ * ImGui operations must be completely wrapped in Begins and Ends
+ *
+ * You may enable and disable rendering by setting the 'rendering' flag to true or false
+ *
+ */
+
 class Gui {
 	
 public: