Move include files in debian packge into 'senf' subdirectory

[senf.git] / PPI / IntervalTimer.hh

diff --git a/PPI/IntervalTimer.hh b/PPI/IntervalTimer.hh
index cfb0631..8cb7f5b 100644 (file)
--- a/PPI/IntervalTimer.hh
+++ b/PPI/IntervalTimer.hh
@@ -27,7 +27,7 @@
 #define HH_IntervalTimer_ 1
 
 // Custom includes
-#include "Scheduler/ClockService.hh"
+#include "../Scheduler/ClockService.hh"
 #include "Events.hh"
 
 //#include "IntervalTimer.mpp"
@@ -36,14 +36,25 @@
 namespace senf {
 namespace ppi {
 
+    /** \brief IntervalTimer event information
+
+        Information passed to the IntervalTimer event handler
+     */
     struct IntervalTimerEventInfo
     {
-        ClockService::clock_type expected;
-        ClockService::clock_type intervalStart;
-        unsigned number;
+        ClockService::clock_type expected; ///< Scheduled event time
+        ClockService::clock_type intervalStart; ///< Start of the current time interval
+        unsigned number;                ///< Number of the current event within the interval
     };
 
-    /** \brief
+    /** \brief High precision regularly signaled event.
+
+        An IntervalTimer signals an event \a eventsPerInterval times each \a interval
+        nanoseconds. The event counter and timer are reset, whenever the event is disabled.
+
+        \see IntervalTimerEventInfo
+
+        \ingroup event_group
       */
     class IntervalTimer
         : public EventImplementation<IntervalTimerEventInfo>