Added documentation

This commit is contained in:
Robert 2021-04-24 02:01:36 +02:00
parent a3726d0887
commit ab2961cf92
413 changed files with 34002 additions and 8 deletions

View file

@ -1,3 +1,11 @@
/*****************************************************************//**
* @file Clock.hpp
* @brief A small timing utility
*
* @author Lauchmelder
* @date April 2021
*********************************************************************/
#pragma once
#include "Util.hpp"
@ -5,12 +13,27 @@
SDLU_BEGIN
/**
* @brief Essentially a timer.
*/
class Clock
{
public:
/**
* @brief Creates a new Clock. It has not yet been started, call Restart() before doing anything else.
*/
Clock();
/**
* @brief Returns the time elapsed since the last Restart() call.
*/
Time GetElapsedTime();
/**
* @brief Restarts the Clock.
*
* @return The time elapsed since the last Restart() call.
*/
Time Restart();
private: