Changeset 7898 in orxonox.OLD for branches/gui/src/lib

Timestamp:

May 27, 2006, 6:05:20 AM (19 years ago)

Author:

bensch

Message:

doxy-tags the most i can do at this time

File:

• branches/gui/src/lib/event/event_handler.cc (modified) (9 diffs)

branches/gui/src/lib/event/event_handler.cc

@@ -29 +29 @@
 
 /**
- *  standard constructor
-*/
+ * @brief standard constructor
+ */
 EventHandler::EventHandler ()
 {
@@ -52 +52 @@
 
 /**
- *  the singleton reference to this class
+ * @brief the singleton reference to this class
 */
 EventHandler* EventHandler::singletonRef = NULL;
@@ -58 +58 @@
 
 /**
- *  standard deconstructor
-
-*/
+ * @brief standard deconstructor
+ */
 EventHandler::~EventHandler ()
 {
@@ -80 +79 @@
 
 /**
- *  initializes the event handler
+ * @brief initializes the event handler
  *
  * this has to be called before the use of the event handler
@@ -118 +117 @@
 
 /**
- * pushes the current State in the State-stack, and selects state
+ * @brief pushes the current State in the State-stack, and selects state
  * @param state the new State to set
  */
@@ -135 +134 @@
 
 /**
- * this removes the topmost stack-entry and select the underlying one
+ * @brief this removes the topmost stack-entry and select the underlying one
  * @returns the next stack-entry
  */
@@ -184 +183 @@
  * @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
-   unsubscribe(EventListener* el, elState state) function
-*/
+ *
+ * if you want to unsubscribe an event listener from all subscribed events, just use the
+ * unsubscribe(EventListener* el, elState state) function
+ */
 void EventHandler::unsubscribe(EventListener* el, elState state, int eventType)
 {
@@ -259 +258 @@
 
 /**
- * flush all registered events
+ * @brief flush all registered events
  * @param state: a specific state
 */
@@ -317 +316 @@
 
 /**
- *  @brief core function of event handler: receives all events from SDL
+ * @brief core function of event handler: receives all events from SDL
  *
  * The event from the SDL framework are collected here and distributed to all listeners.