Changeset 4454 in orxonox.OLD for orxonox/trunk/src/util/event/event_handler.cc

Timestamp:

Jun 1, 2005, 11:29:44 PM (19 years ago)

Author:

patrick

Message:

orxonox/trunk: some more event cleanu[

File:

• orxonox/trunk/src/util/event/event_handler.cc (modified) (5 diffs)

orxonox/trunk/src/util/event/event_handler.cc

@@ -93 +93 @@
 /**
    \brief set the state of the event handler
-   \param state to which the event handler shall change
+   \param state: to which the event handler shall change
 */
 void EventHandler::setState(elState state)
@@ -103 +103 @@
 /**
    \brief subscribe to an event
-   \param the event listener that wants to subscribe itself, the listener that will be called when the evetn occures
-   \param state for which the listener wants to receive events
-   \param the event type that wants to be listened for.
+   \param el: the event listener that wants to subscribe itself, the listener that will be called when the evetn occures
+   \param state: for which the listener wants to receive events
+   \param eventType: the event type that wants to be listened for.
 
    This is one of the most important function of the EventHandler. If you would like to subscribe for more
@@ -134 +134 @@
 /**
    \brief unsubscribe from the EventHandler
-   \param the stat in which it has been subscribed
-   \param the event, that shall be unsubscribed
+   \param state: the stat in which it has been subscribed
+   \param eventType: the event, that shall be unsubscribed
 
    if you want to unsubscribe an event listener from all subscribed events, just use the 
@@ -149 +149 @@
 /**
    \brief unsubscribe all events from a specific listener
-   \param the listener that wants to unsubscribe itself
-   \param the state in which the events shall be unsubscribed
+   \param el: the listener that wants to unsubscribe itself
+   \param state: the state in which the events shall be unsubscribed
    
 */
@@ -179 +179 @@
 /**
    \brief flush all registered events
-   \param in a specific state
+   \param state: a specific state
 */
 void EventHandler::flush(elState state)