Fixed doxygen warnings and corrected documentation in header files.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 05 Jun 2013 23:33:15 +0200
changeset 7278 fc8b57a2a541
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
--- a/include/SDL_events.h	Wed Jun 05 12:48:44 2013 -0700
+++ b/include/SDL_events.h	Wed Jun 05 23:33:15 2013 +0200
@@ -462,7 +462,7 @@
  */
 typedef struct SDL_UserEvent
 {
-    Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_NUMEVENTS-1 */
+    Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_LASTEVENT-1 */
     Uint32 timestamp;
     Uint32 windowID;    /**< The associated window if any */
     Sint32 code;        /**< User defined event code */
@@ -642,7 +642,7 @@
  *  \warning  Be very careful of what you do in the event filter function, as
  *            it may run in a different thread!
  *
- *  There is one caveat when dealing with the ::SDL_QUITEVENT event type.  The
+ *  There is one caveat when dealing with the ::SDL_QuitEvent event type.  The
  *  event filter is only called when the window manager desires to close the
  *  application window.  If the event filter returns 1, then the window will
  *  be closed, otherwise the window will remain open if possible.
--- a/include/SDL_haptic.h	Wed Jun 05 12:48:44 2013 -0700
+++ b/include/SDL_haptic.h	Wed Jun 05 23:33:15 2013 +0200
@@ -1052,8 +1052,7 @@
  *
  *  \param haptic Haptic device to query the effect status on.
  *  \param effect Identifier of the effect to query its status.
- *  \return 0 if it isn't playing, ::SDL_HAPTIC_PLAYING if it is playing
- *          or -1 on error.
+ *  \return 0 if it isn't playing, 1 if it is playing or -1 on error.
  *
  *  \sa SDL_HapticRunEffect
  *  \sa SDL_HapticStopEffect
@@ -1067,8 +1066,8 @@
  *  Device must support the ::SDL_HAPTIC_GAIN feature.
  *
  *  The user may specify the maximum gain by setting the environment variable
- *  ::SDL_HAPTIC_GAIN_MAX which should be between 0 and 100.  All calls to
- *  SDL_HapticSetGain() will scale linearly using ::SDL_HAPTIC_GAIN_MAX as the
+ *  SDL_HAPTIC_GAIN_MAX which should be between 0 and 100.  All calls to
+ *  SDL_HapticSetGain() will scale linearly using SDL_HAPTIC_GAIN_MAX as the
  *  maximum.
  *
  *  \param haptic Haptic device to set the gain on.
--- a/include/SDL_surface.h	Wed Jun 05 12:48:44 2013 -0700
+++ b/include/SDL_surface.h	Wed Jun 05 23:33:15 2013 +0200
@@ -22,7 +22,7 @@
 /**
  *  \file SDL_surface.h
  *
- *  Header file for ::SDL_surface definition and management functions.
+ *  Header file for ::SDL_Surface definition and management functions.
  */
 
 #ifndef _SDL_surface_h
@@ -43,7 +43,7 @@
 /**
  *  \name Surface flags
  *
- *  These are the currently supported flags for the ::SDL_surface.
+ *  These are the currently supported flags for the ::SDL_Surface.
  *
  *  \internal
  *  Used internally (read-only).