Fixed doxygen warnings and corrected documentation in header files.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 05 Jun 2013 23:33:15 +0200
changeset 7278fc8b57a2a541
parent 7277 1290cd7f34af
child 7279 f7805b13b485
Fixed doxygen warnings and corrected documentation in header files.
include/SDL_events.h
include/SDL_haptic.h
include/SDL_surface.h
     1.1 --- a/include/SDL_events.h	Wed Jun 05 12:48:44 2013 -0700
     1.2 +++ b/include/SDL_events.h	Wed Jun 05 23:33:15 2013 +0200
     1.3 @@ -462,7 +462,7 @@
     1.4   */
     1.5  typedef struct SDL_UserEvent
     1.6  {
     1.7 -    Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_NUMEVENTS-1 */
     1.8 +    Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_LASTEVENT-1 */
     1.9      Uint32 timestamp;
    1.10      Uint32 windowID;    /**< The associated window if any */
    1.11      Sint32 code;        /**< User defined event code */
    1.12 @@ -642,7 +642,7 @@
    1.13   *  \warning  Be very careful of what you do in the event filter function, as
    1.14   *            it may run in a different thread!
    1.15   *
    1.16 - *  There is one caveat when dealing with the ::SDL_QUITEVENT event type.  The
    1.17 + *  There is one caveat when dealing with the ::SDL_QuitEvent event type.  The
    1.18   *  event filter is only called when the window manager desires to close the
    1.19   *  application window.  If the event filter returns 1, then the window will
    1.20   *  be closed, otherwise the window will remain open if possible.
     2.1 --- a/include/SDL_haptic.h	Wed Jun 05 12:48:44 2013 -0700
     2.2 +++ b/include/SDL_haptic.h	Wed Jun 05 23:33:15 2013 +0200
     2.3 @@ -1052,8 +1052,7 @@
     2.4   *
     2.5   *  \param haptic Haptic device to query the effect status on.
     2.6   *  \param effect Identifier of the effect to query its status.
     2.7 - *  \return 0 if it isn't playing, ::SDL_HAPTIC_PLAYING if it is playing
     2.8 - *          or -1 on error.
     2.9 + *  \return 0 if it isn't playing, 1 if it is playing or -1 on error.
    2.10   *
    2.11   *  \sa SDL_HapticRunEffect
    2.12   *  \sa SDL_HapticStopEffect
    2.13 @@ -1067,8 +1066,8 @@
    2.14   *  Device must support the ::SDL_HAPTIC_GAIN feature.
    2.15   *
    2.16   *  The user may specify the maximum gain by setting the environment variable
    2.17 - *  ::SDL_HAPTIC_GAIN_MAX which should be between 0 and 100.  All calls to
    2.18 - *  SDL_HapticSetGain() will scale linearly using ::SDL_HAPTIC_GAIN_MAX as the
    2.19 + *  SDL_HAPTIC_GAIN_MAX which should be between 0 and 100.  All calls to
    2.20 + *  SDL_HapticSetGain() will scale linearly using SDL_HAPTIC_GAIN_MAX as the
    2.21   *  maximum.
    2.22   *
    2.23   *  \param haptic Haptic device to set the gain on.
     3.1 --- a/include/SDL_surface.h	Wed Jun 05 12:48:44 2013 -0700
     3.2 +++ b/include/SDL_surface.h	Wed Jun 05 23:33:15 2013 +0200
     3.3 @@ -22,7 +22,7 @@
     3.4  /**
     3.5   *  \file SDL_surface.h
     3.6   *
     3.7 - *  Header file for ::SDL_surface definition and management functions.
     3.8 + *  Header file for ::SDL_Surface definition and management functions.
     3.9   */
    3.10  
    3.11  #ifndef _SDL_surface_h
    3.12 @@ -43,7 +43,7 @@
    3.13  /**
    3.14   *  \name Surface flags
    3.15   *
    3.16 - *  These are the currently supported flags for the ::SDL_surface.
    3.17 + *  These are the currently supported flags for the ::SDL_Surface.
    3.18   *
    3.19   *  \internal
    3.20   *  Used internally (read-only).