Updated documentation

This commit is contained in:
Robert 2020-05-16 18:38:55 +02:00
parent 7abd610258
commit 0611493afd
2 changed files with 12 additions and 2 deletions

View file

@ -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
};
}

View file

@ -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<std::is_arithmetic<T>::value, T>::type