pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed doxygen warnings and corrected documentation in header files.

Browse source
This commit is contained in:
Philipp Wiesemann 2013-06-05 23:33:15 +02:00
parent 24fc22545b
commit c2d84dbad6
3 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/SDL_events.h
View file

@ -462,7 +462,7 @@ typedef struct SDL_OSEvent
*/ */
typedef struct SDL_UserEvent typedef struct SDL_UserEvent
{ {
Uint32 type; /**< ::SDL_USEREVENT through ::SDL_NUMEVENTS-1 */ Uint32 type; /**< ::SDL_USEREVENT through ::SDL_LASTEVENT-1 */
Uint32 timestamp; Uint32 timestamp;
Uint32 windowID; /**< The associated window if any */ Uint32 windowID; /**< The associated window if any */
Sint32 code; /**< User defined event code */ Sint32 code; /**< User defined event code */
@ -642,7 +642,7 @@ typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
* \warning Be very careful of what you do in the event filter function, as * \warning Be very careful of what you do in the event filter function, as
* it may run in a different thread! * 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 * 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 * application window. If the event filter returns 1, then the window will
* be closed, otherwise the window will remain open if possible. * be closed, otherwise the window will remain open if possible.

7
include/SDL_haptic.h
View file

@ -1052,8 +1052,7 @@ extern DECLSPEC void SDLCALL SDL_HapticDestroyEffect(SDL_Haptic * haptic,
* *
* \param haptic Haptic device to query the effect status on. * \param haptic Haptic device to query the effect status on.
* \param effect Identifier of the effect to query its status. * \param effect Identifier of the effect to query its status.
* \return 0 if it isn't playing, ::SDL_HAPTIC_PLAYING if it is playing * \return 0 if it isn't playing, 1 if it is playing or -1 on error.
* or -1 on error.
* *
* \sa SDL_HapticRunEffect * \sa SDL_HapticRunEffect
* \sa SDL_HapticStopEffect * \sa SDL_HapticStopEffect
@ -1067,8 +1066,8 @@ extern DECLSPEC int SDLCALL SDL_HapticGetEffectStatus(SDL_Haptic * haptic,
* Device must support the ::SDL_HAPTIC_GAIN feature. * Device must support the ::SDL_HAPTIC_GAIN feature.
* *
* The user may specify the maximum gain by setting the environment variable * 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_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_HapticSetGain() will scale linearly using SDL_HAPTIC_GAIN_MAX as the
* maximum. * maximum.
* *
* \param haptic Haptic device to set the gain on. * \param haptic Haptic device to set the gain on.

4
include/SDL_surface.h
View file

@ -22,7 +22,7 @@
/** /**
* \file SDL_surface.h * \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 #ifndef _SDL_surface_h
@ -43,7 +43,7 @@ extern "C" {
/** /**
* \name Surface flags * \name Surface flags
* *
* These are the currently supported flags for the ::SDL_surface. * These are the currently supported flags for the ::SDL_Surface.
* *
* \internal * \internal
* Used internally (read-only). * Used internally (read-only).