diff include/SDL_keysym.h @ 3407:d3baf5ac4e37

Partial fix for bug #859 Header file update from Ken for improved doxygen output
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 13:31:58 +0000
parents aba5a5cc2e63
children 5543db4239e6
line wrap: on
line diff
--- a/include/SDL_keysym.h	Sun Oct 18 23:21:15 2009 +0000
+++ b/include/SDL_keysym.h	Mon Oct 19 13:31:58 2009 +0000
@@ -21,7 +21,9 @@
 */
 
 /**
- * \file SDL_keysym.h
+ *  \file SDL_keysym.h
+ *  
+ *  Defines constants which identify keyboard keys and modifiers.
  */
 
 #ifndef _SDL_keysym_h
@@ -31,14 +33,12 @@
 #include "SDL_scancode.h"
 
 /**
- * \typedef SDLKey
- *
- * \brief The SDL virtual key representation.
- *
- * Values of this type are used to represent keyboard keys using the current
- * layout of the keyboard.  These values include Unicode values representing
- * the unmodified character that would be generated by pressing the key, or
- * an SDLK_* constant for those keys that do not generate characters.
+ *  \brief The SDL virtual key representation.
+ *  
+ *  Values of this type are used to represent keyboard keys using the current
+ *  layout of the keyboard.  These values include Unicode values representing
+ *  the unmodified character that would be generated by pressing the key, or
+ *  an SDLK_* constant for those keys that do not generate characters.
  */
 typedef Sint32 SDLKey;
 
@@ -246,9 +246,7 @@
 };
 
 /**
- * \enum SDLMod
- *
- * \brief Enumeration of valid key mods (possibly OR'd together)
+ * \brief Enumeration of valid key mods (possibly OR'd together).
  */
 typedef enum
 {