Skip to content

Commit

Permalink
Fix Timer's documentation about return values (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
knopers8 authored Feb 12, 2020
1 parent 1463358 commit e4ef9bf
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions include/Common/Timer.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ class Timer {
/// Check if time elapsed since timer reset (or last increment set) is bigger than timeout value set.
/// \return Returns 1 if timeout, 0 otherwise.
int isTimeout();

/// \return Returns time elapsed since reset, in microseconds.
double getTime();

/// \return Returns the time until next timeout, in microseconds. This may be a negative value if timeout occured already.
/// \return Returns time elapsed since reset, in seconds.
double getTime();

/// \return Returns the time until next timeout, in seconds. This may be a negative value if timeout occured already.
double getRemainingTime();

private:
Expand Down

0 comments on commit e4ef9bf

Please sign in to comment.