Packets: Fix VariantParser invalid parser access bug

[senf.git] / PPI / Events.hh

diff --git a/PPI/Events.hh b/PPI/Events.hh
index 6f9c9c9..3f2fc25 100644 (file)
--- a/PPI/Events.hh
+++ b/PPI/Events.hh
@@ -1,6 +1,8 @@
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// Copyright (C) 2007
+// 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
@@ -21,12 +23,12 @@
 /** \file
     \brief Events public header */
 
-#ifndef HH_Events_
-#define HH_Events_ 1
+#ifndef HH_SENF_PPI_Events_
+#define HH_SENF_PPI_Events_ 1
 
 // Custom includes
 #include <vector>
-#include "Scheduler/ClockService.hh"
+#include "../Scheduler/ClockService.hh"
 #include "predecl.hh"
 
 //#include "Events.mpp"
@@ -34,6 +36,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 +61,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
     {