PPI: Assert documentation

[senf.git] / Scheduler / EventManager.hh

diff --git a/Scheduler/EventManager.hh b/Scheduler/EventManager.hh
index 56a32ae..f08f019 100644 (file)
--- a/Scheduler/EventManager.hh
+++ b/Scheduler/EventManager.hh
@@ -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);