include/SDL_events.h
changeset 1914 051df511279c
parent 1895 c121d94672cb
child 1957 c7803e4c21d3
     1.1 --- a/include/SDL_events.h	Mon Jul 17 06:47:33 2006 +0000
     1.2 +++ b/include/SDL_events.h	Tue Jul 18 07:49:51 2006 +0000
     1.3 @@ -119,7 +119,7 @@
     1.4  /**
     1.5   * \struct SDL_WindowEvent
     1.6   *
     1.7 - * \brief Window state change event data
     1.8 + * \brief Window state change event data (event.window.*)
     1.9   */
    1.10  typedef struct SDL_WindowEvent
    1.11  {
    1.12 @@ -133,7 +133,7 @@
    1.13  /**
    1.14   * \struct SDL_KeyboardEvent
    1.15   *
    1.16 - * \brief Keyboard button event structure
    1.17 + * \brief Keyboard button event structure (event.key.*)
    1.18   */
    1.19  typedef struct SDL_KeyboardEvent
    1.20  {
    1.21 @@ -147,7 +147,7 @@
    1.22  /**
    1.23   * \struct SDL_TextInputEvent
    1.24   *
    1.25 - * \brief Keyboard text input event structure
    1.26 + * \brief Keyboard text input event structure (event.text.*)
    1.27   */
    1.28  typedef struct SDL_TextInputEvent
    1.29  {
    1.30 @@ -160,7 +160,7 @@
    1.31  /**
    1.32   * \struct SDL_MouseMotionEvent
    1.33   *
    1.34 - * \brief Mouse motion event structure
    1.35 + * \brief Mouse motion event structure (event.motion.*)
    1.36   */
    1.37  typedef struct SDL_MouseMotionEvent
    1.38  {
    1.39 @@ -177,7 +177,7 @@
    1.40  /**
    1.41   * \struct SDL_MouseButtonEvent
    1.42   *
    1.43 - * \brief Mouse button event structure
    1.44 + * \brief Mouse button event structure (event.button.*)
    1.45   */
    1.46  typedef struct SDL_MouseButtonEvent
    1.47  {
    1.48 @@ -193,20 +193,20 @@
    1.49  /**
    1.50   * \struct SDL_MouseWheelEvent
    1.51   *
    1.52 - * \brief Mouse wheel event structure
    1.53 + * \brief Mouse wheel event structure (event.wheel.*)
    1.54   */
    1.55  typedef struct SDL_MouseWheelEvent
    1.56  {
    1.57      Uint8 type;             /**< SDL_MOUSEWHEEL */
    1.58      Uint8 which;            /**< The mouse device index */
    1.59 -    int motion;                                 /**< The direction and distance scrolled */
    1.60 +    int motion;             /**< The direction and distance scrolled */
    1.61      SDL_WindowID windowID;  /**< The window with mouse focus, if any */
    1.62  } SDL_MouseWheelEvent;
    1.63  
    1.64  /**
    1.65   * \struct SDL_JoyAxisEvent
    1.66   *
    1.67 - * \brief Joystick axis motion event structure
    1.68 + * \brief Joystick axis motion event structure (event.jaxis.*)
    1.69   */
    1.70  typedef struct SDL_JoyAxisEvent
    1.71  {
    1.72 @@ -219,7 +219,7 @@
    1.73  /**
    1.74   * \struct SDL_JoyBallEvent
    1.75   *
    1.76 - * \brief Joystick trackball motion event structure
    1.77 + * \brief Joystick trackball motion event structure (event.jball.*)
    1.78   */
    1.79  typedef struct SDL_JoyBallEvent
    1.80  {
    1.81 @@ -233,7 +233,7 @@
    1.82  /**
    1.83   * \struct SDL_JoyHatEvent
    1.84   *
    1.85 - * \brief Joystick hat position change event structure
    1.86 + * \brief Joystick hat position change event structure (event.jhat.*)
    1.87   */
    1.88  typedef struct SDL_JoyHatEvent
    1.89  {
    1.90 @@ -251,7 +251,7 @@
    1.91  /**
    1.92   * \struct SDL_JoyButtonEvent
    1.93   *
    1.94 - * \brief Joystick button event structure
    1.95 + * \brief Joystick button event structure (event.jbutton.*)
    1.96   */
    1.97  typedef struct SDL_JoyButtonEvent
    1.98  {
    1.99 @@ -274,7 +274,7 @@
   1.100  /**
   1.101   * \struct SDL_UserEvent
   1.102   *
   1.103 - * \brief A user-defined event type
   1.104 + * \brief A user-defined event type (event.user.*)
   1.105   */
   1.106  typedef struct SDL_UserEvent
   1.107  {
   1.108 @@ -287,7 +287,7 @@
   1.109  /**
   1.110   * \struct SDL_SysWMEvent
   1.111   *
   1.112 - * \brief A video driver dependent system event
   1.113 + * \brief A video driver dependent system event (event.syswm.*)
   1.114   *
   1.115   * \note If you want to use this event, you should include SDL_syswm.h
   1.116   */