Utils/Console: Add short help to 'ls' output

[senf.git] / Scheduler / EventManager.hh

diff --git a/Scheduler/EventManager.hh b/Scheduler/EventManager.hh
index 56a32ae..099ebae 100644 (file)
--- a/Scheduler/EventManager.hh
+++ b/Scheduler/EventManager.hh
@@ -23,8 +23,8 @@
 /** \file
     \brief EventManager public header */
 
-#ifndef HH_SchedulerEventManager_
-#define HH_SchedulerEventManager_ 1
+#ifndef HH_SENF_Scheduler_EventManager_
+#define HH_SENF_Scheduler_EventManager_ 1
 
 // Custom includes
 #include <string>
@@ -32,7 +32,7 @@
 #include "../boost/intrusive/ilist.hpp"
 #include "../boost/intrusive/ilist_hook.hpp"
 #include "../Utils/singleton.hh"
-#include "Console/LazyDirectory.hh"
+#include "../Utils/Console/LazyDirectory.hh"
 
 //#include "EventManager.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
@@ -65,11 +65,11 @@ namespace detail {
         ///@}
         ///////////////////////////////////////////////////////////////////////////
 
-        std::string const & name() const;
-        bool enabled() const;
-        unsigned runCount() const;
-        char const * type() const;
-        std::string info() const;
+        std::string const & name() const; ///< Get event name
+        bool enabled() const;           ///< \c true, if event is enabled, \c false otherwise
+        unsigned runCount() const;      ///< Number of times, event was fired
+        char const * type() const;      ///< Event type code
+        std::string info() const;       ///< Additional event information
 
     protected:
         void countRun();
@@ -88,15 +88,16 @@ namespace detail {
     class EventManager
         : public singleton<EventManager>
     {
-        struct IteratorFilter {
-            bool operator()(Event const & e);
-        };
-
     public:
         using singleton<EventManager>::instance;
         using singleton<EventManager>::alive;
         
-        typedef boost::filter_iterator<IteratorFilter, EventList::const_iterator> iterator;
+        struct IteratorFilter {
+            bool operator()(Event const & e);
+        };
+
+        typedef boost::filter_iterator<
+            IteratorFilter, EventList::const_iterator> iterator;
 
         void add(Event & event);
         void remove(Event & event);
@@ -104,6 +105,8 @@ namespace detail {
         iterator begin() const;
         iterator end() const;
 
+        void listEvents(std::ostream & os);
+
     protected:
 
     private:
@@ -114,8 +117,6 @@ namespace detail {
         friend class singleton<EventManager>;
 
 #ifndef SENF_DISABLE_CONSOLE
-        void consoleEvents(std::ostream & os);
-        
         console::LazyDirectory consoleDir_;
 #endif
     };