Skip to content

Commit 45c81f4

Browse files
author
Dieter Niklaus
committed
correct ctor timeMillis param description for doxygen
1 parent 192a866 commit 45c81f4

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎SpinTimer.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ class SpinTimer
115115
public:
116116
/**
117117
* Timer constructor.
118-
* @param timeMillis Timer interval/timeout time [ms], >0: timer starts automatically after creation, 0: timer remains stopped after creation (timer will expire as soon as possible when started with startTimer())
118+
* @param timeMillis Time out or interval time to be set for the timer [ms]; 0 will make the timer expire as soon as possible.
119119
* @param action SpinTimerAction, is able to emit a timer expired event to any specific listener, default: 0 (no event will be sent)
120120
* @param isRecurring Operation mode, true: recurring, false: non-recurring, default: false
121121
* @param isAutostart Autostart mode, true: autostart enabled, false: autostart disabled, default: false
@@ -190,7 +190,7 @@ class SpinTimer
190190
bool isRunning() const;
191191

192192
/**
193-
* Returns the actual interval of the timer.
193+
* Returns the current interval of the timer.
194194
* @return Timer interval/timeout time [ms].
195195
*/
196196
unsigned long getInterval() const;

0 commit comments

Comments
 (0)