summaryrefslogtreecommitdiff
path: root/src/timeout.cc
diff options
context:
space:
mode:
authorRodrigo Arias Mallo <rodarima@gmail.com>2024-03-09 17:35:19 +0100
committerrodarima <rodarima@gmail.com>2024-03-09 18:43:51 +0100
commit4c56214b8c2e130d3709bdca2513aef20b7b0fab (patch)
treeb8cd0c6dafb5850ba116221f6f39a62e84983aa5 /src/timeout.cc
parentbde09c45adf0daf252fafbaf87683d3ed7eaab07 (diff)
Use Doxygen comments for C files
Diffstat (limited to 'src/timeout.cc')
-rw-r--r--src/timeout.cc10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/timeout.cc b/src/timeout.cc
index 1ddcd5e1..f00b374e 100644
--- a/src/timeout.cc
+++ b/src/timeout.cc
@@ -9,14 +9,16 @@
* (at your option) any later version.
*/
-// Simple ADT for timeout functions
+/** @file
+ * Simple ADT for timeout functions
+ */
#include <FL/Fl.H>
#include "timeout.hh"
// C++ functions with C linkage ----------------------------------------------
-/*
+/**
* Hook a one-time timeout function 'cb' after 't' seconds
* with 'cbdata" as its data.
*/
@@ -25,7 +27,7 @@ void a_Timeout_add(float t, TimeoutCb_t cb, void *cbdata)
Fl::add_timeout(t, cb, cbdata);
}
-/*
+/**
* To be called from inside the 'cb' function when it wants to keep running
*/
void a_Timeout_repeat(float t, TimeoutCb_t cb, void *cbdata)
@@ -33,7 +35,7 @@ void a_Timeout_repeat(float t, TimeoutCb_t cb, void *cbdata)
Fl::add_timeout(t, cb, cbdata);
}
-/*
+/**
* Stop running a timeout function
*/
void a_Timeout_remove()