summaryrefslogtreecommitdiff
path: root/src/Fl_Timeout.cxx
diff options
context:
space:
mode:
authorManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2022-03-25 16:54:53 +0100
committerManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2022-03-25 16:54:53 +0100
commit0ab3ca7cf6fac682e6ee598077df3ec3859918ab (patch)
treecc31103c86cf8f1481eef5291b10c8022d0b7d1a /src/Fl_Timeout.cxx
parent427e4dbc7a31407f3e8ca80f2dd2a84869af4b3d (diff)
Remove documentation of non-existant function return values.
Diffstat (limited to 'src/Fl_Timeout.cxx')
-rw-r--r--src/Fl_Timeout.cxx5
1 files changed, 1 insertions, 4 deletions
diff --git a/src/Fl_Timeout.cxx b/src/Fl_Timeout.cxx
index 197719737..21200462d 100644
--- a/src/Fl_Timeout.cxx
+++ b/src/Fl_Timeout.cxx
@@ -220,16 +220,13 @@ void Fl_Timeout::make_current() {
Remove the top-most timeout from the stack of currently running
timeout callbacks and insert it into the list of free timers.
- This should always return a non-NULL value, otherwise there's a bug
- in the library. Typical code in the library would look like:
+ Typical code in the library would look like:
\code
// The timeout \p Fl_Timeout *t has exired, run its callback
t->make_current();
(t->callback)(t->data);
t->release();
\endcode
-
- \return Fl_Timeout* current timeout or NULL
*/
void Fl_Timeout::release() {
Fl_Timeout *t = current_timeout;