summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2022-10-09 14:30:32 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2022-10-09 14:30:32 +0200
commit4d17cf310dc953703bf3a60763b681eb217bc3e9 (patch)
treee640245faa9d316ea1900d7cd7d43b565b9a6d37
parentf2532964cc8b326d00354f11d551727795a99319 (diff)
Fix documentation of Fl_Timeout::insert()
-rw-r--r--src/Fl_Timeout.cxx13
1 files changed, 3 insertions, 10 deletions
diff --git a/src/Fl_Timeout.cxx b/src/Fl_Timeout.cxx
index f93b86354..d530a87df 100644
--- a/src/Fl_Timeout.cxx
+++ b/src/Fl_Timeout.cxx
@@ -97,17 +97,10 @@ static double elapsed_time() {
}
/**
- Insert a timer entry into the active timer queue.
+ Insert this timer entry into the active timer queue.
- The base class Fl_Timeout inserts the timer as the first entry in
- the queue of active timers. The default implementation is sufficient
- for macOS and Windows.
-
- Derived classes (e.g. Fl_Timeout) can override this method.
- Currently the Posix timeout handling (Unix, Linux) does this so
- the timer queue entries are ordered by due time.
-
- \param[in] t Timer to be inserted (Fl_Timeout or derived class)
+ The timer is inserted at the required position so the timer queue
+ is always ordered by due time.
*/
void Fl_Timeout::insert() {
Fl_Timeout **p = (Fl_Timeout **)&first_timeout;