Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/event

Timestamp:

Jul 12, 2005, 12:33:16 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit

Location:

orxonox/trunk/src/lib/event

Files:

• event.cc (modified) (2 diffs)
• event.h (modified) (1 diff)
• event_def.h (modified) (1 diff)
• event_handler.cc (modified) (11 diffs)
• event_handler.h (modified) (2 diffs)
• event_listener.cc (modified) (1 diff)
• event_listener.h (modified) (2 diffs)
• key_mapper.cc (modified) (6 diffs)
• key_mapper.h (modified) (1 diff)
• key_names.h (modified) (2 diffs)

orxonox/trunk/src/lib/event/event.cc

@@ -22 +22 @@
 
 /**
-   \brief standard constructor
+ *  standard constructor
 */
 Event::Event () 
@@ -32 +32 @@
 
 /**
-   \brief standard deconstructor
+ *  standard deconstructor
 
 */

orxonox/trunk/src/lib/event/event.h

@@ -1 +1 @@
 /*!
     \file event.h
-    \brief an abstract event
+  *  an abstract event
 
 */

orxonox/trunk/src/lib/event/event_def.h

@@ -1 +1 @@
 /*!
     \file event_def.h
-    \brief some central definitions
+  *  some central definitions
 
 */

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

@@ -29 +29 @@
 
 /**
-   \brief standard constructor
+ *  standard constructor
 */
 EventHandler::EventHandler ()
@@ -52 +52 @@
 
 /**
-   \brief the singleton reference to this class
+ *  the singleton reference to this class
 */
 EventHandler* EventHandler::singletonRef = NULL;
@@ -58 +58 @@
 
 /**
-   \brief standard deconstructor
+ *  standard deconstructor
 
 */
@@ -80 +80 @@
 
 /**
-   \brief initializes the event handler
+ *  initializes the event handler
 
    this has to be called before the use of the event handler
@@ -92 +92 @@
 
 /**
-   \brief set the state of the event handler
-   \param state: to which the event handler shall change
+ *  set the state of the event handler
+ * @param state: to which the event handler shall change
 */
 void EventHandler::setState(elState state)
@@ -102 +102 @@
 
 /**
-   \brief subscribe to an event
-   \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.
+ *  subscribe to an event
+ * @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
@@ -111 +111 @@
    state = ES_ALL, which will subscribe your listener for all states together.
  *
- * \todo this can also be done with the & operator, and checking for states, just set the esState to 1,2,4,8, and then 15 is equal to ES_ALL
+ * @todo this can also be done with the & operator, and checking for states, just set the esState to 1,2,4,8, and then 15 is equal to ES_ALL
 */
 void EventHandler::subscribe(EventListener* el, elState state, int eventType)
@@ -135 +135 @@
 
 /**
-   \brief unsubscribe from the EventHandler
-   \param state: the stat in which it has been subscribed
-   \param eventType: the event, that shall be unsubscribed
+ *  unsubscribe from the EventHandler
+ * @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
@@ -150 +150 @@
 
 /**
-   \brief unsubscribe all events from a specific listener
-   \param el: the listener that wants to unsubscribe itself
-   \param state: the state in which the events shall be unsubscribed
+ *  unsubscribe all events from a specific listener
+ * @param el: the listener that wants to unsubscribe itself
+ * @param state: the state in which the events shall be unsubscribed
 
 */
@@ -182 +182 @@
 
 /**
-   \brief flush all registered events
-   \param state: a specific state
+ *  flush all registered events
+ * @param state: a specific state
 */
 void EventHandler::flush(elState state)
@@ -208 +208 @@
 
 /**
-   \brief core function of event handler: receives all events from SDL
+ *  core function of event handler: receives all events from SDL
 
    The event from the SDL framework are collected here and distributed to all listeners.

orxonox/trunk/src/lib/event/event_handler.h

@@ -1 +1 @@
 /*!
     \file event_handler.h
-    \brief Definition of the EventHandler
+  *  Definition of the EventHandler
 
 */
@@ -21 +21 @@
  public:
   virtual ~EventHandler();
-  /** \returns a Pointer to the only object of this Class */
+  /** @returns a Pointer to the only object of this Class */
   inline static EventHandler* getInstance() { if (!singletonRef) singletonRef = new EventHandler();  return singletonRef; };
   void init();

orxonox/trunk/src/lib/event/event_listener.cc

@@ -23 +23 @@
 
 /**
-   \brief standard constructor
+ *  standard constructor
 */
 EventListener::EventListener ()
 {
-   this->setClassID(CL_EVENT_LISTENER, "EventListener");
+  this->setClassID(CL_EVENT_LISTENER, "EventListener");
 }
 
 
 /**
-   \brief standard deconstructor
-
+ *  standard deconstructor
 */
 EventListener::~EventListener ()

orxonox/trunk/src/lib/event/event_listener.h

@@ -1 +1 @@
 /*! 
     \file event_listener.h
-    \brief Definition of an event listener base class
+  *  Definition of an event listener base class
 
 */
@@ -21 +21 @@
 
   /**
-     \brief abstract function that processes events from the handler
-     \param event: the event
+   *  abstract function that processes events from the handler
+   * @param event: the event
   */
   virtual void process(const Event &event) = NULL;

orxonox/trunk/src/lib/event/key_mapper.cc

@@ -92 +92 @@
 
 /**
-   \brief standard constructor
+ *  standard constructor
 */
 KeyMapper::KeyMapper ()
@@ -101 +101 @@
 
 /**
-   \brief standard deconstructor
+ *  standard deconstructor
 */
 KeyMapper::~KeyMapper ()
@@ -109 +109 @@
 
 /**
-   \brief loads new key bindings from a file
-   \param filename: The path and name of the file to load the bindings from
+ *  loads new key bindings from a file
+ * @param filename: The path and name of the file to load the bindings from
 */
 void KeyMapper::loadKeyBindings (const char* fileName)
@@ -189 +189 @@
 
 /**
-   \brief this function looks up name to key index
-   \param the name of the button
+ *  this function looks up name to key index
+ * @param the name of the button
 */
 int* KeyMapper::nameToIndex (char* name)
@@ -212 +212 @@
 
 /**
-   \brief the function maps name to key ids
-   \param name of the key
-   \param id of the key
+ *  the function maps name to key ids
+ * @param name of the key
+ * @param id of the key
 */
 void KeyMapper::mapKeys(char* name, int keyID)
@@ -231 +231 @@
 
 /**
-   \brief this function gives some debug information about the key mapper class
+ *  this function gives some debug information about the key mapper class
 */
 void KeyMapper::debug()

orxonox/trunk/src/lib/event/key_mapper.h

@@ -1 +1 @@
 /*! 
     \file key_mapper.h
-    \brief a construct to map player defined keys to SDL keys
+  *  a construct to map player defined keys to SDL keys
 
 */

orxonox/trunk/src/lib/event/key_names.h

@@ -1 +1 @@
 /*!
     \file keynames.h
-    \brief Key/button naming functions
+  *  Key/button naming functions
 
                 Converts strings to SDLK/SDL_BUTTON values and vice versa
@@ -9 +9 @@
 
 /**
-        \brief converts a button name string to a integer representing the corresponding SDL mouse button identifier
-        \param name: the name of the mouse button
-        \return an int containing the SDL identifier of the mouse button or -1 if the button name is not valid
+      *  converts a button name string to a integer representing the corresponding SDL mouse button identifier
+      * @param name: the name of the mouse button
+      * @return an int containing the SDL identifier of the mouse button or -1 if the button name is not valid
 */
 int buttonnameToSDLB(const char* name);
 
 /**
-        \brief converst a SDL mouse button identifier to a name string
-        \param button: an SDL mouse button identifier
-        \return a pointer to a string containing the name of the mouse button
+      *  converst a SDL mouse button identifier to a name string
+      * @param button: an SDL mouse button identifier
+      * @return a pointer to a string containing the name of the mouse button
 */
 char* SDLBToButtonname( int button);
 
 /**
-        \brief converts a key name string to a integer representing the corresponding SDLK sym
-        \param name: the name of the key
-        \return the SDLK sym of the named key or -1 if the key name is not valid
+      *  converts a key name string to a integer representing the corresponding SDLK sym
+      * @param name: the name of the key
+      * @return the SDLK sym of the named key or -1 if the key name is not valid
 */
 int keynameToSDLK(const char* name);
 
 /**
-        \brief converts an SDLK sym to a name string
-        \param key: the SDLK sym
-        \return a pointer to a string containig the name of the key
+      *  converts an SDLK sym to a name string
+      * @param key: the SDLK sym
+      * @return a pointer to a string containig the name of the key
 */
 char* SDLKToKeyname( int key);