corrected documentation
This commit is contained in:
parent
1181ebcbda
commit
25ff8784cf
@ -1,9 +1,3 @@
|
|||||||
/**
|
|
||||||
* @file Stopwatch.cpp
|
|
||||||
*
|
|
||||||
* @date 08.04.2020
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <framework/timemanager/Stopwatch.h>
|
#include <framework/timemanager/Stopwatch.h>
|
||||||
#include <framework/serviceinterface/ServiceInterfaceStream.h>
|
#include <framework/serviceinterface/ServiceInterfaceStream.h>
|
||||||
#include <iomanip>
|
#include <iomanip>
|
||||||
|
@ -1,9 +1,3 @@
|
|||||||
/**
|
|
||||||
* @file Stopwatch.h
|
|
||||||
*
|
|
||||||
* @date 08.04.2020
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef FRAMEWORK_TIMEMANAGER_STOPWATCH_H_
|
#ifndef FRAMEWORK_TIMEMANAGER_STOPWATCH_H_
|
||||||
#define FRAMEWORK_TIMEMANAGER_STOPWATCH_H_
|
#define FRAMEWORK_TIMEMANAGER_STOPWATCH_H_
|
||||||
#include <framework/timemanager/Clock.h>
|
#include <framework/timemanager/Clock.h>
|
||||||
@ -18,8 +12,7 @@ enum class StopwatchDisplayMode {
|
|||||||
* @details
|
* @details
|
||||||
* This class can be used to measure elapsed times. It also displays elapsed
|
* This class can be used to measure elapsed times. It also displays elapsed
|
||||||
* times automatically on destruction if not explicitely deactivated in the
|
* times automatically on destruction if not explicitely deactivated in the
|
||||||
* constructor. The default time format is the elapsed time in miliseconds
|
* constructor. The default time format is the elapsed time in miliseconds.
|
||||||
* as a float.
|
|
||||||
*/
|
*/
|
||||||
class Stopwatch {
|
class Stopwatch {
|
||||||
public:
|
public:
|
||||||
@ -28,8 +21,8 @@ public:
|
|||||||
* no parameters are required!
|
* no parameters are required!
|
||||||
* @param displayOnDestruction If set to true, displays measured time on
|
* @param displayOnDestruction If set to true, displays measured time on
|
||||||
* object destruction
|
* object destruction
|
||||||
* @param displayMode Display format is either MS rounded or MS as double
|
* @param displayMode Display format is either MS rounded or seconds as
|
||||||
* format
|
* double format
|
||||||
* @param outputPrecision If using double format, specify precision here.
|
* @param outputPrecision If using double format, specify precision here.
|
||||||
*/
|
*/
|
||||||
Stopwatch(bool displayOnDestruction = true, StopwatchDisplayMode displayMode
|
Stopwatch(bool displayOnDestruction = true, StopwatchDisplayMode displayMode
|
||||||
|
Loading…
Reference in New Issue
Block a user