Changeset 2141 in orxonox.OLD for orxonox/branches/chris/src/keynames.h

Timestamp:

Jul 14, 2004, 3:31:42 PM (20 years ago)

Author:

chris

Message:

orxonox/branches/chris: added lots and lots of doxygen tags

File:

• orxonox/branches/chris/src/keynames.h (modified) (1 diff)

orxonox/branches/chris/src/keynames.h

@@ -12 +12 @@
 #include <SDL/SDL.h>
 
+/**
+        \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
+*/
 int buttonname_to_SDLB( 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
+*/
 char* SDLB_to_buttonname( 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
+*/
 int keyname_to_SDLK( 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
+*/
 char* SDLK_to_keyname( int key);