Merge branch '20-add-doxygen-comments-to-existing-code' of...

Merge branch '20-add-doxygen-comments-to-existing-code' of gitlab.uni-koblenz.de:vulkan2021/vkcv-framework into 20-add-doxygen-comments-to-existing-code

src/vkcv/CoreManager.hpp

@@ -6,11 +6,12 @@
 namespace vkcv {
 
     /**
-     * initialize GLFW if not initialized
+     * initializes glfw once and increases the counter
      */
     void initGLFW();
+
     /**
-     * terminate GLFW
+     * terminates glfw once, if it was initialized or decreases the counter
      */
     void terminateGLFW();
 }

src/vkcv/Window.hpp

@@ -12,19 +12,47 @@ namespace vkcv {
         GLFWwindow *m_window;
 
     public:
+        /**
+         * creates a GLFWwindow with the parameters in the function
+         * @param windowTitle
+         * @param width
+         * @param height
+         * @param resizable
+         * @return Window class
+         */
         static Window create(const char *windowTitle, int width = -1, int height = -1, bool resizable = false);
 
+        /**
+         * checks if the window is still open, or the close event was called
+         * This function should be changed/removed later on
+         * @return bool if the window is still open
+         */
         [[nodiscard]]
         bool isWindowOpen() const;
 
+        /**
+         * polls all events on the GLFWwindow
+         */
         static void pollEvents();
 
+        /**
+         * returns the current window
+         * @return window handle
+         */
         [[nodiscard]]
         GLFWwindow *getWindow() const;
 
+        /**
+         * gets the current window width
+         * @return int with window width
+         */
         [[nodiscard]]
         int getWidth() const;
 
+        /**
+         * gets the current window height
+         * @return int with window height
+         */
         [[nodiscard]]
         int getHeight() const;