X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FIntervalTimer.hh;h=66a07981e4278d2b4eb7a37a16e47550fedc1a36;hb=e57e1ec99a16261d1f436d1ea42f60dda6aae5cc;hp=cfb06310053a721af727e3824ae34f84fec482bb;hpb=0327b3f303ea2a61d44a30bfaac022874dcf2a0d;p=senf.git

diff --git a/PPI/IntervalTimer.hh b/PPI/IntervalTimer.hh
index cfb0631..66a0798 100644
--- a/PPI/IntervalTimer.hh
+++ b/PPI/IntervalTimer.hh
@@ -1,8 +1,8 @@
 // $Id$
 //
 // Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// Fraunhofer Institute for Open Communication Systems (FOKUS) 
+// Competence Center NETwork research (NET), St. Augustin, GERMANY 
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -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>