Add SENF internal senf::SenfLog debug stream and make it default for the 'senf' names...

[senf.git] / PPI / Events.hh

diff --git a/PPI/Events.hh b/PPI/Events.hh
index 6f9c9c9..bb55784 100644 (file)
--- a/PPI/Events.hh
+++ b/PPI/Events.hh
@@ -26,7 +26,7 @@
 
 // Custom includes
 #include <vector>
-#include "Scheduler/ClockService.hh"
+#include "../Scheduler/ClockService.hh"
 #include "predecl.hh"
 
 //#include "Events.mpp"
@@ -34,6 +34,19 @@
 
 namespace senf {
 namespace ppi {
+    
+    /** \defgroup event_group Events
+
+        Events provide notification of events outside the PPI framework: I/O activity, Timers
+        etc. Events are very important since they drive the PPI: Without events, nothing will
+        happen.
+
+        \section event_impl Implementing Events
+
+        All events are derived from EventImplementation which is based on EventDescriptor.
+        \see EventImplementation \n
+            \ref ppi_events        
+     */
 
     // Implementation: The concrete EventDescriptor implementation will need to set things up so
     // some callback (within the EventDescriptor implementation) will be called when the event
@@ -46,6 +59,8 @@ namespace ppi {
     /** \brief Generic event interface base-class
 
         The EventDescriptor base-class provides an interface to control events.
+
+        \see \ref ppi_events
      */ 
     class EventDescriptor
     {