Added documentation

include/openglu.hpp

@@ -1,17 +1,48 @@
+/*****************************************************************//**
+ * @file   openglu.hpp
+ * @brief  Basic includes and some exposed OpenGL
+ * 
+ * @author Lauchmelder
+ * @date   January 2021
+ *********************************************************************/
 #ifndef OPENGLU_HPP
 #define OPENGLU_HPP
 
 #include <color.hpp>
-#include <object.hpp>
+#include <vertexArray.hpp>
 #include <shader.hpp>
 #include <texture.hpp>
 
 namespace oglu
 {
+	/**
+	 * @brief Loads the GL Loader to be used by OGLU.
+	 * 
+	 * OpenGL function addresses can vary across platforms and drivers, so we
+	 * need to know where these functions are in order to work properly.
+	 * 
+	 * @param[in] proc A pointer to a function that returns the addresses of OpenGL functions
+	 */
 	OGLU_API void LoadGLLoader(GLADloadproc proc);
 
-	// Some raw, exposed OpenGL until I know where to put then
+	/**
+	 * @brief Wrapper of glViewport.
+	 * 
+	 * @param[in] x Horizontal Position of the viewport
+	 * @param[in] y Vertical Position of the viewport
+	 * @param[in] width Width of the viewport
+	 * @param[in] height Height of the viewport
+	 */
 	OGLU_API void SetViewport(GLint x, GLint y, GLsizei width, GLsizei height);
+
+	/**
+	 * @brief Convenience function for glClear
+	 * 
+	 * Sets the clear color and then clears the screen.
+	 * 
+	 * @param[in] mask Buffers to be cleared
+	 * @param[in] clearColor Color to clear the screen with
+	 */
 	OGLU_API void ClearScreen(GLbitfield mask, Color clearColor);
 }