Scheduler: Add POSIX/UNIX signal support

[senf.git] / PPI / IdleEvent.hh

diff --git a/PPI/IdleEvent.hh b/PPI/IdleEvent.hh
index 3064380..93362bd 100644 (file)
--- a/PPI/IdleEvent.hh
+++ b/PPI/IdleEvent.hh
@@ -35,6 +35,13 @@
 namespace senf {
 namespace ppi {
 
+    /** \brief Continually signaled event
+
+        An IdleEvent is signaled continually and repeatedly while enabled. It will consume 100% of
+        available CPU resources. The resource usage is controlled by adequate event throttling.
+        
+        \ingroup event_group
+     */
     class IdleEvent
         : public EventImplementation<>
     {