summaryrefslogtreecommitdiff
path: root/src/libcamera/event_dispatcher.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/libcamera/event_dispatcher.cpp')
-rw-r--r--src/libcamera/event_dispatcher.cpp10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/libcamera/event_dispatcher.cpp b/src/libcamera/event_dispatcher.cpp
index f7c40734..b82c59c3 100644
--- a/src/libcamera/event_dispatcher.cpp
+++ b/src/libcamera/event_dispatcher.cpp
@@ -104,4 +104,14 @@ EventDispatcher::~EventDispatcher()
* it before returning.
*/
+/**
+ * \fn EventDispatcher::interrupt()
+ * \brief Interrupt any running processEvents() call as soon as possible
+ *
+ * Calling this function interrupts any blocking processEvents() call in
+ * progress. The processEvents() function will return as soon as possible,
+ * after processing pending timers and events. If processEvents() isn't in
+ * progress, it will be interrupted immediately the next time it gets called.
+ */
+
} /* namespace libcamera */