From 0611493afd957b292535628ca776efb5cfc7ef72 Mon Sep 17 00:00:00 2001 From: Robert Date: Sat, 16 May 2020 18:38:55 +0200 Subject: [PATCH] Updated documentation --- SDLU/graphics/RenderWindow.hpp | 9 +++++++-- SDLU/structures/Vector2.hpp | 5 +++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/SDLU/graphics/RenderWindow.hpp b/SDLU/graphics/RenderWindow.hpp index e303002..e204d27 100644 --- a/SDLU/graphics/RenderWindow.hpp +++ b/SDLU/graphics/RenderWindow.hpp @@ -12,6 +12,11 @@ namespace sdlu { + /** + * A class that combines the SDL_Window and SDL_Renderer and + * behaves similar to the sf::RenderWindow from SFML. It provides + * utility and wrappers for common operations on those objects. + */ class RenderWindow { public: @@ -46,7 +51,7 @@ namespace sdlu Uint32 windowFlags, Uint32 rendererFlags); private: - SDL_Window* m_pWindow; - SDL_Renderer* m_pRenderer; + SDL_Window* m_pWindow; ///< A pointer to the window object + SDL_Renderer* m_pRenderer; ///< A pointer to the renderer object }; } \ No newline at end of file diff --git a/SDLU/structures/Vector2.hpp b/SDLU/structures/Vector2.hpp index f7ac172..1e4071b 100644 --- a/SDLU/structures/Vector2.hpp +++ b/SDLU/structures/Vector2.hpp @@ -9,6 +9,11 @@ namespace sdlu { + /** + * A struct to handle basic 2D vector operations. + * + * @tparam T The (arithmetical) type of the vector components + */ template< typename T, typename = typename std::enable_if::value, T>::type