Packets: Add StringParser ostream operation

[senf.git] / PPI / DebugEvent.hh

diff --git a/PPI/DebugEvent.hh b/PPI/DebugEvent.hh
index 3a2f254..12268f6 100644 (file)
--- a/PPI/DebugEvent.hh
+++ b/PPI/DebugEvent.hh
@@ -1,8 +1,8 @@
 // $Id$
 //
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// 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
@@ -23,8 +23,8 @@
 /** \file
     \brief DebugEvent public header */
 
-#ifndef HH_DebugEvent_
-#define HH_DebugEvent_ 1
+#ifndef HH_SENF_PPI_DebugEvent_
+#define HH_SENF_PPI_DebugEvent_ 1
 
 // Custom includes
 #include "Events.hh"
@@ -35,7 +35,10 @@
 namespace senf {
 namespace ppi {
 
-    /** \brief
+    /** \brief Manually triggered event
+
+        DebugEvent is a manually triggered event. The event is triggered by explicit calls to
+        trigger() and not by the event infrastructure.
       */
     class DebugEvent
         : public EventImplementation<>
@@ -57,7 +60,7 @@ namespace ppi {
         ///@}
         ///////////////////////////////////////////////////////////////////////////
 
-        void trigger();
+        void trigger();                 ///< Trigger event
 
     protected: