Added documenting comments

Author: LessComplexity

CMakeLists.txt

@@ -18,8 +18,11 @@ add_executable(${APP_NAME} main.cpp
         glshift/GLManager.h
         glshift/GLShift.h
         glshift/definitions.h
-        glshift/GLRenderer.h glshift/GLRenderer.cpp)
+        glshift/GLRenderer.h
+        glshift/GLRenderer.cpp)
 
+# Linking libraries for windows/linux
+# TODO: add mac support
 if(WIN32)
     # Neccessary variables
     SET(LINK_GL_LIBS ${CMAKE_SOURCE_DIR}/lib/win/${ARCHITECTURE_TO_USE})

glshift/GLManager.cpp

@@ -40,6 +40,7 @@ void GLShift::GLManager::openWindow(int width, int height, const char* title,boo
 
 void GLShift::GLManager::setRenderer(GLShift::GLRenderer *renderer) {
     this->renderer = renderer;
+    // Call initialization function
     this->renderer->init();
 }
 

glshift/GLManager.h

@@ -9,12 +9,40 @@
 
 class GLShift::GLManager {
 public:
+    /**
+     * Initializes the GLFW environment
+     */
     GLManager();
-    ~GLManager();
+    /**
+     * Initializes the GLFW environment & sets the specific version
+     * of OpenGL to use
+     * @param major
+     * @param minor
+     */
     GLManager(signed int major, signed int minor);
+    /**
+     * Terminated the GLFW environment
+     */
+    ~GLManager();
 
+    /**
+     * Sets the version of OpenGL to use
+     * @param major
+     * @param minor
+     */
     void setVersion(signed int major, signed int minor);
+    /**
+     * Sets the renderer object to use for rendering on the window
+     * @param renderer
+     */
     void setRenderer(GLRenderer * renderer);
+    /**
+     * Opens a window with GLFW context
+     * @param width
+     * @param height
+     * @param title
+     * @param isFullScreen Set true to make full screen app
+     */
     void openWindow(signed int width, signed int height, const char* title, bool isFullScreen = false);
     void run();
 private:

glshift/GLRenderer.cpp

@@ -2,8 +2,4 @@
 // Created by lesscomplex on 08/03/2020.
 //
 
-#include "GLRenderer.h"
-
-GLShift::GLRenderer::GLRenderer(GLShift::GLManager *context) {
-    this->context = context;
-}
+#include "GLRenderer.h"

glshift/GLRenderer.h

@@ -9,11 +9,14 @@
 
 class GLShift::GLRenderer {
 public:
-    explicit GLRenderer(GLManager* context);
+    /**
+     * Override to provide code for the rendering loop
+     */
     virtual void render() = 0;
+    /**
+     * Override to provide code for the initialization loop
+     */
     virtual void init() = 0;
-private:
-    GLManager * context;
 };
 
 #endif //YOURAPPNAME_GLRENDERER_H

glshift/definitions.h

@@ -9,7 +9,13 @@
 #include <GLFW/glfw3.h>
 
 namespace GLShift {
+    /**
+     * Helps manage a window with GLFW context
+     */
     class GLManager;
+    /**
+     * Defines the functionality for rendering the screen
+     */
     class GLRenderer;
 }
 

main.cpp

@@ -1,7 +1,9 @@
 #include "glshift/GLShift.h"
 
+/**
+ * Example for a renderer implementation
+ */
 class MyRenderer : public GLShift::GLRenderer {
-    using GLShift::GLRenderer::GLRenderer; // Import constructor
 public:
     void render() override {
         glClearColor(1, 0, 0, 1);
@@ -11,9 +13,12 @@ class MyRenderer : public GLShift::GLRenderer {
 };
 
 int main() {
+    /**
+     * Example for a GLManager implementation
+     */
     GLShift::GLManager glManager = GLShift::GLManager();
     glManager.openWindow(600, 300, "Yeahh!");
-    glManager.setRenderer(new MyRenderer(&glManager));
+    glManager.setRenderer(new MyRenderer());
     glManager.run();
     return 0;
 }