From 4d17cf310dc953703bf3a60763b681eb217bc3e9 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Sun, 9 Oct 2022 14:30:32 +0200 Subject: Fix documentation of Fl_Timeout::insert() --- src/Fl_Timeout.cxx | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) (limited to 'src') 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; -- cgit v1.2.3