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

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

File:

• orxonox/trunk/src/lib/event/key_names.h (modified) (2 diffs)

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);