Skip to content
Snippets Groups Projects
Verified Commit daebb5ba authored by Tobias Frisch's avatar Tobias Frisch
Browse files

Adjusted doxygen comments of the window

parent a0c5eb5d
No related branches found
No related tags found
1 merge request!97Resolve "Dokumentation vervollständigen"
...@@ -51,14 +51,14 @@ namespace vkcv { ...@@ -51,14 +51,14 @@ namespace vkcv {
/** /**
* @brief Copy-constructor of a #Window * @brief Copy-constructor of a #Window
* *
* @param other Other instance of #Window * @param[in] other Other instance of #Window
*/ */
Window(const Window& other) = delete; Window(const Window& other) = delete;
/** /**
* @brief Copy-operator of a #Window * @brief Copy-operator of a #Window
* *
* @param other Other instance of #Window * @param[in] other Other instance of #Window
* @return Reference to itself * @return Reference to itself
*/ */
Window &operator=(const Window &other) = delete; Window &operator=(const Window &other) = delete;
...@@ -73,7 +73,7 @@ namespace vkcv { ...@@ -73,7 +73,7 @@ namespace vkcv {
bool isOpen() const; bool isOpen() const;
/** /**
* @brief Gets the currently focused window and returns it * @brief Returns the currently focused window.
* TODO: only accessible to WindowManager * TODO: only accessible to WindowManager
* *
* @return Current window in focus * @return Current window in focus
...@@ -81,14 +81,14 @@ namespace vkcv { ...@@ -81,14 +81,14 @@ namespace vkcv {
static Window& getFocusedWindow(); static Window& getFocusedWindow();
/** /**
* @brief Checks if any GLFWWindows are open * @brief Checks if any windows are active and open.
* *
* @return True, if any window is open, else false * @return True, if any window is open, else false
*/ */
static bool hasOpenWindow(); static bool hasOpenWindow();
/** /**
* @brief Polls all events on the GLFWwindow * @brief Polls all events on the active windows.
*/ */
static void pollEvents(); static void pollEvents();
...@@ -148,12 +148,13 @@ namespace vkcv { ...@@ -148,12 +148,13 @@ namespace vkcv {
bool isResizable() const; bool isResizable() const;
/** /**
* Destructor of #Window, terminates GLFW * @brief Destructor of the window which terminates GLFW in case
* of the last window got destroyed.
*/ */
virtual ~Window(); virtual ~Window();
/** /**
* Requests the windows framebuffer size * @brief Requests the windows framebuffer size.
* *
* @param[out] width * @param[out] width
* @param[out] height * @param[out] height
...@@ -161,7 +162,7 @@ namespace vkcv { ...@@ -161,7 +162,7 @@ namespace vkcv {
void getFramebufferSize(int& width, int& height) const; void getFramebufferSize(int& width, int& height) const;
/** /**
* @brief Retruns the andle of the swapchain in use by the window. * @brief Retruns the handle of the swapchain in use by the window.
* *
* @return Swapchain handle * @return Swapchain handle
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment