geemili
/
SDL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

test: don't use wiki urls for documentation comments 

Also make consistent use of \ as documentation escape character.
main
Anonymous Maarten 2023-02-02 00:21:53 +01:00
parent bff449eb24
commit 08bcee8570
31 changed files with 434 additions and 510 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/render/software/SDL_rotate.c
View File

@ -43,7 +43,7 @@ Andreas Schiffler -- aschiffler at ferzkopp dot net
/* ---- Internally used structures */ /* ---- Internally used structures */
/* ! /**
\brief A 32 bit RGBA pixel. \brief A 32 bit RGBA pixel.
*/ */
typedef struct tColorRGBA typedef struct tColorRGBA
@ -54,7 +54,7 @@ typedef struct tColorRGBA
Uint8 a; Uint8 a;
} tColorRGBA; } tColorRGBA;
/* ! /**
\brief A 8bit Y/palette pixel. \brief A 8bit Y/palette pixel.
*/ */
typedef struct tColorY typedef struct tColorY
@ -62,7 +62,7 @@ typedef struct tColorY
Uint8 y; Uint8 y;
} tColorY; } tColorY;
/* ! /**
\brief Number of guard rows added to destination surfaces. \brief Number of guard rows added to destination surfaces.
This is a simple but effective workaround for observed issues. This is a simple but effective workaround for observed issues.
@ -74,7 +74,7 @@ to a situation where the program can segfault.
*/ */
#define GUARD_ROWS (2) #define GUARD_ROWS (2)
/* ! /**
\brief Returns colorkey info for a surface \brief Returns colorkey info for a surface
*/ */
static Uint32 get_colorkey(SDL_Surface *src) static Uint32 get_colorkey(SDL_Surface *src)
@ -99,14 +99,14 @@ static void rotate(double sx, double sy, double sinangle, double cosangle, const
*dy += center->y; *dy += center->y;
} }
/* ! /**
\brief Internal target surface sizing function for rotations with trig result return. \brief Internal target surface sizing function for rotations with trig result return.
\param width The source surface width. \param width The source surface width.
\param height The source surface height. \param height The source surface height.
\param angle The angle to rotate in degrees. \param angle The angle to rotate in degrees.
\param dstwidth The calculated width of the destination surface. \param center The center of ratation
\param dstheight The calculated height of the destination surface. \param rect_dest Bounding box of rotated rectangle
\param cangle The sine of the angle \param cangle The sine of the angle
\param sangle The cosine of the angle \param sangle The cosine of the angle
@ -248,7 +248,7 @@ static void transformSurfaceY90(SDL_Surface *src, SDL_Surface *dst, int angle, i
#undef TRANSFORM_SURFACE_90 #undef TRANSFORM_SURFACE_90
/* ! /**
\brief Internal 32 bit rotozoomer with optional anti-aliasing. \brief Internal 32 bit rotozoomer with optional anti-aliasing.
Rotates and zooms 32 bit RGBA/ABGR 'src' surface to 'dst' surface based on the control Rotates and zooms 32 bit RGBA/ABGR 'src' surface to 'dst' surface based on the control
@ -264,7 +264,7 @@ Assumes dst surface was allocated with the correct dimensions.
\param flipx Flag indicating horizontal mirroring should be applied. \param flipx Flag indicating horizontal mirroring should be applied.
\param flipy Flag indicating vertical mirroring should be applied. \param flipy Flag indicating vertical mirroring should be applied.
\param smooth Flag indicating anti-aliasing should be used. \param smooth Flag indicating anti-aliasing should be used.
\param dst_rect destination coordinates \param rect_dest destination coordinates
\param center true center. \param center true center.
*/ */
static void transformSurfaceRGBA(SDL_Surface *src, SDL_Surface *dst, int isin, int icos, static void transformSurfaceRGBA(SDL_Surface *src, SDL_Surface *dst, int isin, int icos,
@ -389,7 +389,7 @@ static void transformSurfaceRGBA(SDL_Surface *src, SDL_Surface *dst, int isin, i
} }
} }
/* ! /**
\brief Rotates and zooms 8 bit palette/Y 'src' surface to 'dst' surface without smoothing. \brief Rotates and zooms 8 bit palette/Y 'src' surface to 'dst' surface without smoothing.
@ -404,7 +404,7 @@ Assumes dst surface was allocated with the correct dimensions.
\param icos Integer version of cosine of angle. \param icos Integer version of cosine of angle.
\param flipx Flag indicating horizontal mirroring should be applied. \param flipx Flag indicating horizontal mirroring should be applied.
\param flipy Flag indicating vertical mirroring should be applied. \param flipy Flag indicating vertical mirroring should be applied.
\param dst_rect destination coordinates \param rect_dest destination coordinates
\param center true center. \param center true center.
*/ */
static void transformSurfaceY(SDL_Surface *src, SDL_Surface *dst, int isin, int icos, int flipx, int flipy, static void transformSurfaceY(SDL_Surface *src, SDL_Surface *dst, int isin, int icos, int flipx, int flipy,
@ -461,7 +461,7 @@ static void transformSurfaceY(SDL_Surface *src, SDL_Surface *dst, int isin, int
} }
} }
/* ! /**
\brief Rotates and zooms a surface with different horizontal and vertival scaling factors and optional anti-aliasing. \brief Rotates and zooms a surface with different horizontal and vertival scaling factors and optional anti-aliasing.
Rotates a 32-bit or 8-bit 'src' surface to newly created 'dst' surface. Rotates a 32-bit or 8-bit 'src' surface to newly created 'dst' surface.
@ -475,7 +475,6 @@ When using the NONE and MOD modes, color and alpha modulation must be applied be
\param src The surface to rotozoom. \param src The surface to rotozoom.
\param angle The angle to rotate in degrees. \param angle The angle to rotate in degrees.
\param zoomy The vertical coordinate of the center of rotation
\param smooth Antialiasing flag; set to SMOOTHING_ON to enable. \param smooth Antialiasing flag; set to SMOOTHING_ON to enable.
\param flipx Set to 1 to flip the image horizontally \param flipx Set to 1 to flip the image horizontally
\param flipy Set to 1 to flip the image vertically \param flipy Set to 1 to flip the image vertically

4
src/test/SDL_test_fuzzer.c
View File

@ -161,7 +161,7 @@ SDLTest_RandomIntegerInRange(Sint32 pMin, Sint32 pMax)
return (Sint32)((number % ((max + 1) - min)) + min); return (Sint32)((number % ((max + 1) - min)) + min);
} }
/* ! /**
* Generates a unsigned boundary value between the given boundaries. * Generates a unsigned boundary value between the given boundaries.
* Boundary values are inclusive. See the examples below. * Boundary values are inclusive. See the examples below.
* If boundary2 < boundary1, the values are swapped. * If boundary2 < boundary1, the values are swapped.
@ -288,7 +288,7 @@ SDLTest_RandomUint64BoundaryValue(Uint64 boundary1, Uint64 boundary2, SDL_bool v
validDomain); validDomain);
} }
/* ! /**
* Generates a signed boundary value between the given boundaries. * Generates a signed boundary value between the given boundaries.
* Boundary values are inclusive. See the examples below. * Boundary values are inclusive. See the examples below.
* If boundary2 < boundary1, the values are swapped. * If boundary2 < boundary1, the values are swapped.

2
src/test/SDL_test_log.c
View File

@ -46,7 +46,7 @@ strftime_gcc2_workaround(char *s, size_t max, const char *fmt, const struct tm *
#define strftime strftime_gcc2_workaround #define strftime strftime_gcc2_workaround
#endif #endif
/* ! /**
* Converts unix timestamp to its ascii representation in localtime * Converts unix timestamp to its ascii representation in localtime
* *
* Note: Uses a static buffer internally, so the return value * Note: Uses a static buffer internally, so the return value

1
test/testatomic.c
View File

@ -9,6 +9,7 @@
including commercial applications, and to alter it and redistribute it including commercial applications, and to alter it and redistribute it
freely. freely.
*/ */
#include <SDL3/SDL.h> #include <SDL3/SDL.h>
#include <SDL3/SDL_main.h> #include <SDL3/SDL_main.h>

50
test/testautomation_audio.c
View File

@ -57,8 +57,8 @@ static SDL_AudioDeviceID g_audio_id = -1;
/** /**
* \brief Stop and restart audio subsystem * \brief Stop and restart audio subsystem
* *
* \sa https://wiki.libsdl.org/SDL_QuitSubSystem * \sa SDL_QuitSubSystem
* \sa https://wiki.libsdl.org/SDL_InitSubSystem * \sa SDL_InitSubSystem
*/ */
static int audio_quitInitAudioSubSystem(void *arg) static int audio_quitInitAudioSubSystem(void *arg)
{ {
@ -75,8 +75,8 @@ static int audio_quitInitAudioSubSystem(void *arg)
/** /**
* \brief Start and stop audio directly * \brief Start and stop audio directly
* *
* \sa https://wiki.libsdl.org/SDL_InitAudio * \sa SDL_InitAudio
* \sa https://wiki.libsdl.org/SDL_QuitAudio * \sa SDL_QuitAudio
*/ */
static int audio_initQuitAudio(void *arg) static int audio_initQuitAudio(void *arg)
{ {
@ -131,10 +131,10 @@ static int audio_initQuitAudio(void *arg)
/** /**
* \brief Start, open, close and stop audio * \brief Start, open, close and stop audio
* *
* \sa https://wiki.libsdl.org/SDL_InitAudio * \sa SDL_InitAudio
* \sa https://wiki.libsdl.org/SDL_OpenAudioDevice * \sa SDL_OpenAudioDevice
* \sa https://wiki.libsdl.org/SDL_CloseAudioDevice * \sa SDL_CloseAudioDevice
* \sa https://wiki.libsdl.org/SDL_QuitAudio * \sa SDL_QuitAudio
*/ */
static int audio_initOpenCloseQuitAudio(void *arg) static int audio_initOpenCloseQuitAudio(void *arg)
{ {
@ -223,8 +223,8 @@ static int audio_initOpenCloseQuitAudio(void *arg)
/** /**
* \brief Pause and unpause audio * \brief Pause and unpause audio
* *
* \sa https://wiki.libsdl.org/SDL_PauseAudioDevice * \sa SDL_PauseAudioDevice
* \sa https://wiki.libsdl.org/SDL_PlayAudioDevice * \sa SDL_PlayAudioDevice
*/ */
static int audio_pauseUnpauseAudio(void *arg) static int audio_pauseUnpauseAudio(void *arg)
{ {
@ -350,8 +350,8 @@ static int audio_pauseUnpauseAudio(void *arg)
/** /**
* \brief Enumerate and name available audio devices (output and capture). * \brief Enumerate and name available audio devices (output and capture).
* *
* \sa https://wiki.libsdl.org/SDL_GetNumAudioDevices * \sa SDL_GetNumAudioDevices
* \sa https://wiki.libsdl.org/SDL_GetAudioDeviceName * \sa SDL_GetAudioDeviceName
*/ */
static int audio_enumerateAndNameAudioDevices(void *arg) static int audio_enumerateAndNameAudioDevices(void *arg)
{ {
@ -408,8 +408,8 @@ static int audio_enumerateAndNameAudioDevices(void *arg)
/** /**
* \brief Negative tests around enumeration and naming of audio devices. * \brief Negative tests around enumeration and naming of audio devices.
* *
* \sa https://wiki.libsdl.org/SDL_GetNumAudioDevices * \sa SDL_GetNumAudioDevices
* \sa https://wiki.libsdl.org/SDL_GetAudioDeviceName * \sa SDL_GetAudioDeviceName
*/ */
static int audio_enumerateAndNameAudioDevicesNegativeTests(void *arg) static int audio_enumerateAndNameAudioDevicesNegativeTests(void *arg)
{ {
@ -454,8 +454,8 @@ static int audio_enumerateAndNameAudioDevicesNegativeTests(void *arg)
/** /**
* \brief Checks available audio driver names. * \brief Checks available audio driver names.
* *
* \sa https://wiki.libsdl.org/SDL_GetNumAudioDrivers * \sa SDL_GetNumAudioDrivers
* \sa https://wiki.libsdl.org/SDL_GetAudioDriver * \sa SDL_GetAudioDriver
*/ */
static int audio_printAudioDrivers(void *arg) static int audio_printAudioDrivers(void *arg)
{ {
@ -485,7 +485,7 @@ static int audio_printAudioDrivers(void *arg)
/** /**
* \brief Checks current audio driver name with initialized audio. * \brief Checks current audio driver name with initialized audio.
* *
* \sa https://wiki.libsdl.org/SDL_GetCurrentAudioDriver * \sa SDL_GetCurrentAudioDriver
*/ */
static int audio_printCurrentAudioDriver(void *arg) static int audio_printCurrentAudioDriver(void *arg)
{ {
@ -516,7 +516,7 @@ static int g_audioFrequencies[] = { 11025, 22050, 44100, 48000 };
/** /**
* \brief Builds various audio conversion structures * \brief Builds various audio conversion structures
* *
* \sa https://wiki.libsdl.org/SDL_CreateAudioStream * \sa SDL_CreateAudioStream
*/ */
static int audio_buildAudioStream(void *arg) static int audio_buildAudioStream(void *arg)
{ {
@ -581,7 +581,7 @@ static int audio_buildAudioStream(void *arg)
/** /**
* \brief Checks calls with invalid input to SDL_CreateAudioStream * \brief Checks calls with invalid input to SDL_CreateAudioStream
* *
* \sa https://wiki.libsdl.org/SDL_CreateAudioStream * \sa SDL_CreateAudioStream
*/ */
static int audio_buildAudioStreamNegative(void *arg) static int audio_buildAudioStreamNegative(void *arg)
{ {
@ -662,7 +662,7 @@ static int audio_buildAudioStreamNegative(void *arg)
/** /**
* \brief Checks current audio status. * \brief Checks current audio status.
* *
* \sa https://wiki.libsdl.org/SDL_GetAudioDeviceStatus * \sa SDL_GetAudioDeviceStatus
*/ */
static int audio_getAudioStatus(void *arg) static int audio_getAudioStatus(void *arg)
{ {
@ -681,7 +681,7 @@ static int audio_getAudioStatus(void *arg)
/** /**
* \brief Opens, checks current audio status, and closes a device. * \brief Opens, checks current audio status, and closes a device.
* *
* \sa https://wiki.libsdl.org/SDL_GetAudioStatus * \sa SDL_GetAudioStatus
*/ */
static int audio_openCloseAndGetAudioStatus(void *arg) static int audio_openCloseAndGetAudioStatus(void *arg)
{ {
@ -741,8 +741,8 @@ static int audio_openCloseAndGetAudioStatus(void *arg)
/** /**
* \brief Locks and unlocks open audio device. * \brief Locks and unlocks open audio device.
* *
* \sa https://wiki.libsdl.org/SDL_LockAudioDevice * \sa SDL_LockAudioDevice
* \sa https://wiki.libsdl.org/SDL_UnlockAudioDevice * \sa SDL_UnlockAudioDevice
*/ */
static int audio_lockUnlockOpenAudioDevice(void *arg) static int audio_lockUnlockOpenAudioDevice(void *arg)
{ {
@ -805,7 +805,7 @@ static int audio_lockUnlockOpenAudioDevice(void *arg)
/** /**
* \brief Convert audio using various conversion structures * \brief Convert audio using various conversion structures
* *
* \sa https://wiki.libsdl.org/SDL_CreateAudioStream * \sa SDL_CreateAudioStream
*/ */
static int audio_convertAudio(void *arg) static int audio_convertAudio(void *arg)
{ {
@ -929,7 +929,7 @@ static int audio_convertAudio(void *arg)
/** /**
* \brief Opens, checks current connected status, and closes a device. * \brief Opens, checks current connected status, and closes a device.
* *
* \sa https://wiki.libsdl.org/SDL_AudioDeviceConnected * \sa SDL_AudioDeviceConnected
*/ */
static int audio_openCloseAudioDeviceConnected(void *arg) static int audio_openCloseAudioDeviceConnected(void *arg)
{ {

32
test/testautomation_clipboard.c
View File

@ -11,8 +11,7 @@
/** /**
* \brief Check call to SDL_HasClipboardText * \brief Check call to SDL_HasClipboardText
* *
* \sa * \sa SDL_HasClipboardText
* http://wiki.libsdl.org/SDL_HasClipboardText
*/ */
int clipboard_testHasClipboardText(void *arg) int clipboard_testHasClipboardText(void *arg)
{ {
@ -25,8 +24,7 @@ int clipboard_testHasClipboardText(void *arg)
/** /**
* \brief Check call to SDL_HasPrimarySelectionText * \brief Check call to SDL_HasPrimarySelectionText
* *
* \sa * \sa SDL_HasPrimarySelectionText
* http://wiki.libsdl.org/SDL_HasPrimarySelectionText
*/ */
int clipboard_testHasPrimarySelectionText(void *arg) int clipboard_testHasPrimarySelectionText(void *arg)
{ {
@ -39,8 +37,7 @@ int clipboard_testHasPrimarySelectionText(void *arg)
/** /**
* \brief Check call to SDL_GetClipboardText * \brief Check call to SDL_GetClipboardText
* *
* \sa * \sa SDL_GetClipboardText
* http://wiki.libsdl.org/SDL_GetClipboardText
*/ */
int clipboard_testGetClipboardText(void *arg) int clipboard_testGetClipboardText(void *arg)
{ {
@ -56,8 +53,7 @@ int clipboard_testGetClipboardText(void *arg)
/** /**
* \brief Check call to SDL_GetPrimarySelectionText * \brief Check call to SDL_GetPrimarySelectionText
* *
* \sa * \sa SDL_GetPrimarySelectionText
* http://wiki.libsdl.org/SDL_GetPrimarySelectionText
*/ */
int clipboard_testGetPrimarySelectionText(void *arg) int clipboard_testGetPrimarySelectionText(void *arg)
{ {
@ -72,8 +68,7 @@ int clipboard_testGetPrimarySelectionText(void *arg)
/** /**
* \brief Check call to SDL_SetClipboardText * \brief Check call to SDL_SetClipboardText
* \sa * \sa SDL_SetClipboardText
* http://wiki.libsdl.org/SDL_SetClipboardText
*/ */
int clipboard_testSetClipboardText(void *arg) int clipboard_testSetClipboardText(void *arg)
{ {
@ -100,8 +95,7 @@ int clipboard_testSetClipboardText(void *arg)
/** /**
* \brief Check call to SDL_SetPrimarySelectionText * \brief Check call to SDL_SetPrimarySelectionText
* \sa * \sa SDL_SetPrimarySelectionText
* http://wiki.libsdl.org/SDL_SetPrimarySelectionText
*/ */
int clipboard_testSetPrimarySelectionText(void *arg) int clipboard_testSetPrimarySelectionText(void *arg)
{ {
@ -128,10 +122,9 @@ int clipboard_testSetPrimarySelectionText(void *arg)
/** /**
* \brief End-to-end test of SDL_xyzClipboardText functions * \brief End-to-end test of SDL_xyzClipboardText functions
* \sa * \sa SDL_HasClipboardText
* http://wiki.libsdl.org/SDL_HasClipboardText * \sa SDL_GetClipboardText
* http://wiki.libsdl.org/SDL_GetClipboardText * \sa SDL_SetClipboardText
* http://wiki.libsdl.org/SDL_SetClipboardText
*/ */
int clipboard_testClipboardTextFunctions(void *arg) int clipboard_testClipboardTextFunctions(void *arg)
{ {
@ -206,10 +199,9 @@ int clipboard_testClipboardTextFunctions(void *arg)
/** /**
* \brief End-to-end test of SDL_xyzPrimarySelectionText functions * \brief End-to-end test of SDL_xyzPrimarySelectionText functions
* \sa * \sa SDL_HasPrimarySelectionText
* http://wiki.libsdl.org/SDL_HasPrimarySelectionText * \sa SDL_GetPrimarySelectionText
* http://wiki.libsdl.org/SDL_GetPrimarySelectionText * \sa SDL_SetPrimarySelectionText
* http://wiki.libsdl.org/SDL_SetPrimarySelectionText
*/ */
int clipboard_testPrimarySelectionTextFunctions(void *arg) int clipboard_testPrimarySelectionTextFunctions(void *arg)
{ {

18
test/testautomation_events.c
View File

@ -37,10 +37,10 @@ static int SDLCALL events_sampleNullEventFilter(void *userdata, SDL_Event *event
} }
/** /**
* @brief Test pumping and peeking events. * \brief Test pumping and peeking events.
* *
* @sa http://wiki.libsdl.org/SDL_PumpEvents * \sa SDL_PumpEvents
* @sa http://wiki.libsdl.org/SDL_PollEvent * \sa SDL_PollEvent
*/ */
int events_pushPumpAndPollUserevent(void *arg) int events_pushPumpAndPollUserevent(void *arg)
{ {
@ -69,10 +69,10 @@ int events_pushPumpAndPollUserevent(void *arg)
} }
/** /**
* @brief Adds and deletes an event watch function with NULL userdata * \brief Adds and deletes an event watch function with NULL userdata
* *
* @sa http://wiki.libsdl.org/SDL_AddEventWatch * \sa SDL_AddEventWatch
* @sa http://wiki.libsdl.org/SDL_DelEventWatch * \sa SDL_DelEventWatch
* *
*/ */
int events_addDelEventWatch(void *arg) int events_addDelEventWatch(void *arg)
@ -118,10 +118,10 @@ int events_addDelEventWatch(void *arg)
} }
/** /**
* @brief Adds and deletes an event watch function with userdata * \brief Adds and deletes an event watch function with userdata
* *
* @sa http://wiki.libsdl.org/SDL_AddEventWatch * \sa SDL_AddEventWatch
* @sa http://wiki.libsdl.org/SDL_DelEventWatch * \sa SDL_DelEventWatch
* *
*/ */
int events_addDelEventWatchWithUserdata(void *arg) int events_addDelEventWatchWithUserdata(void *arg)

8
test/testautomation_guid.c
View File

@ -55,9 +55,9 @@ upper_lower_to_bytestring(Uint8 *out, Uint64 upper, Uint64 lower)
/* Test case functions */ /* Test case functions */
/** /**
* @brief Check String-to-GUID conversion * \brief Check String-to-GUID conversion
* *
* @sa SDL_GUIDFromString * \sa SDL_GUIDFromString
*/ */
static int static int
TestGuidFromString(void *arg) TestGuidFromString(void *arg)
@ -80,9 +80,9 @@ TestGuidFromString(void *arg)
} }
/** /**
* @brief Check GUID-to-String conversion * \brief Check GUID-to-String conversion
* *
* @sa SDL_GUIDToString * \sa SDL_GUIDToString
*/ */
static int static int
TestGuidToString(void *arg) TestGuidToString(void *arg)

4
test/testautomation_hints.c
View File

@ -59,7 +59,7 @@ const int numHintsEnum = SDL_arraysize(HintsEnum);
/* Test case functions */ /* Test case functions */
/** /**
* @brief Call to SDL_GetHint * \brief Call to SDL_GetHint
*/ */
int hints_getHint(void *arg) int hints_getHint(void *arg)
{ {
@ -88,7 +88,7 @@ static void SDLCALL hints_testHintChanged(void *userdata, const char *name, cons
} }
/** /**
* @brief Call to SDL_SetHint * \brief Call to SDL_SetHint
*/ */
int hints_setHint(void *arg) int hints_setHint(void *arg)
{ {

4
test/testautomation_joystick.c
View File

@ -11,9 +11,9 @@
/* Test case functions */ /* Test case functions */
/** /**
* @brief Check virtual joystick creation * \brief Check virtual joystick creation
* *
* @sa SDL_AttachVirtualJoystickEx * \sa SDL_AttachVirtualJoystickEx
*/ */
static int static int
TestVirtualJoystick(void *arg) TestVirtualJoystick(void *arg)

66
test/testautomation_keyboard.c
View File

@ -10,9 +10,9 @@
/* Test case functions */ /* Test case functions */
/** /**
* @brief Check call to SDL_GetKeyboardState with and without numkeys reference. * \brief Check call to SDL_GetKeyboardState with and without numkeys reference.
* *
* @sa http://wiki.libsdl.org/SDL_GetKeyboardState * \sa SDL_GetKeyboardState
*/ */
int keyboard_getKeyboardState(void *arg) int keyboard_getKeyboardState(void *arg)
{ {
@ -35,9 +35,9 @@ int keyboard_getKeyboardState(void *arg)
} }
/** /**
* @brief Check call to SDL_GetKeyboardFocus * \brief Check call to SDL_GetKeyboardFocus
* *
* @sa http://wiki.libsdl.org/SDL_GetKeyboardFocus * \sa SDL_GetKeyboardFocus
*/ */
int keyboard_getKeyboardFocus(void *arg) int keyboard_getKeyboardFocus(void *arg)
{ {
@ -49,9 +49,9 @@ int keyboard_getKeyboardFocus(void *arg)
} }
/** /**
* @brief Check call to SDL_GetKeyFromName for known, unknown and invalid name. * \brief Check call to SDL_GetKeyFromName for known, unknown and invalid name.
* *
* @sa http://wiki.libsdl.org/SDL_GetKeyFromName * \sa SDL_GetKeyFromName
*/ */
int keyboard_getKeyFromName(void *arg) int keyboard_getKeyFromName(void *arg)
{ {
@ -114,9 +114,9 @@ static void checkInvalidScancodeError()
} }
/** /**
* @brief Check call to SDL_GetKeyFromScancode * \brief Check call to SDL_GetKeyFromScancode
* *
* @sa http://wiki.libsdl.org/SDL_GetKeyFromScancode * \sa SDL_GetKeyFromScancode
*/ */
int keyboard_getKeyFromScancode(void *arg) int keyboard_getKeyFromScancode(void *arg)
{ {
@ -152,9 +152,9 @@ int keyboard_getKeyFromScancode(void *arg)
} }
/** /**
* @brief Check call to SDL_GetKeyName * \brief Check call to SDL_GetKeyName
* *
* @sa http://wiki.libsdl.org/SDL_GetKeyName * \sa SDL_GetKeyName
*/ */
int keyboard_getKeyName(void *arg) int keyboard_getKeyName(void *arg)
{ {
@ -207,9 +207,9 @@ int keyboard_getKeyName(void *arg)
} }
/** /**
* @brief SDL_GetScancodeName negative cases * \brief SDL_GetScancodeName negative cases
* *
* @sa http://wiki.libsdl.org/SDL_GetScancodeName * \sa SDL_GetScancodeName
*/ */
int keyboard_getScancodeNameNegative(void *arg) int keyboard_getScancodeNameNegative(void *arg)
{ {
@ -233,9 +233,9 @@ int keyboard_getScancodeNameNegative(void *arg)
} }
/** /**
* @brief SDL_GetKeyName negative cases * \brief SDL_GetKeyName negative cases
* *
* @sa http://wiki.libsdl.org/SDL_GetKeyName * \sa SDL_GetKeyName
*/ */
int keyboard_getKeyNameNegative(void *arg) int keyboard_getKeyNameNegative(void *arg)
{ {
@ -269,10 +269,10 @@ int keyboard_getKeyNameNegative(void *arg)
} }
/** /**
* @brief Check call to SDL_GetModState and SDL_SetModState * \brief Check call to SDL_GetModState and SDL_SetModState
* *
* @sa http://wiki.libsdl.org/SDL_GetModState * \sa SDL_GetModState
* @sa http://wiki.libsdl.org/SDL_SetModState * \sa SDL_SetModState
*/ */
int keyboard_getSetModState(void *arg) int keyboard_getSetModState(void *arg)
{ {
@ -328,10 +328,10 @@ int keyboard_getSetModState(void *arg)
} }
/** /**
* @brief Check call to SDL_StartTextInput and SDL_StopTextInput * \brief Check call to SDL_StartTextInput and SDL_StopTextInput
* *
* @sa http://wiki.libsdl.org/SDL_StartTextInput * \sa SDL_StartTextInput
* @sa http://wiki.libsdl.org/SDL_StopTextInput * \sa SDL_StopTextInput
*/ */
int keyboard_startStopTextInput(void *arg) int keyboard_startStopTextInput(void *arg)
{ {
@ -374,9 +374,9 @@ static void testSetTextInputRect(SDL_Rect refRect)
} }
/** /**
* @brief Check call to SDL_SetTextInputRect * \brief Check call to SDL_SetTextInputRect
* *
* @sa http://wiki.libsdl.org/SDL_SetTextInputRect * \sa SDL_SetTextInputRect
*/ */
int keyboard_setTextInputRect(void *arg) int keyboard_setTextInputRect(void *arg)
{ {
@ -453,9 +453,9 @@ int keyboard_setTextInputRect(void *arg)
} }
/** /**
* @brief Check call to SDL_SetTextInputRect with invalid data * \brief Check call to SDL_SetTextInputRect with invalid data
* *
* @sa http://wiki.libsdl.org/SDL_SetTextInputRect * \sa SDL_SetTextInputRect
*/ */
int keyboard_setTextInputRectNegative(void *arg) int keyboard_setTextInputRectNegative(void *arg)
{ {
@ -490,10 +490,10 @@ int keyboard_setTextInputRectNegative(void *arg)
} }
/** /**
* @brief Check call to SDL_GetScancodeFromKey * \brief Check call to SDL_GetScancodeFromKey
* *
* @sa http://wiki.libsdl.org/SDL_GetScancodeFromKey * \sa SDL_GetScancodeFromKey
* @sa http://wiki.libsdl.org/SDL_Keycode * \sa SDL_Keycode
*/ */
int keyboard_getScancodeFromKey(void *arg) int keyboard_getScancodeFromKey(void *arg)
{ {
@ -513,10 +513,10 @@ int keyboard_getScancodeFromKey(void *arg)
} }
/** /**
* @brief Check call to SDL_GetScancodeFromName * \brief Check call to SDL_GetScancodeFromName
* *
* @sa http://wiki.libsdl.org/SDL_GetScancodeFromName * \sa SDL_GetScancodeFromName
* @sa http://wiki.libsdl.org/SDL_Keycode * \sa SDL_Keycode
*/ */
int keyboard_getScancodeFromName(void *arg) int keyboard_getScancodeFromName(void *arg)
{ {
@ -584,10 +584,10 @@ static void checkInvalidNameError()
} }
/** /**
* @brief Check call to SDL_GetScancodeFromName with invalid data * \brief Check call to SDL_GetScancodeFromName with invalid data
* *
* @sa http://wiki.libsdl.org/SDL_GetScancodeFromName * \sa SDL_GetScancodeFromName
* @sa http://wiki.libsdl.org/SDL_Keycode * \sa SDL_Keycode
*/ */
int keyboard_getScancodeFromNameNegative(void *arg) int keyboard_getScancodeFromNameNegative(void *arg)
{ {

7
test/testautomation_main.c
View File

@ -9,11 +9,10 @@
#include <SDL3/SDL.h> #include <SDL3/SDL.h>
#include <SDL3/SDL_test.h> #include <SDL3/SDL_test.h>
/* ! /**
* \brief Tests SDL_InitSubSystem() and SDL_QuitSubSystem() * \brief Tests SDL_InitSubSystem() and SDL_QuitSubSystem()
* \sa * \sa SDL_Init
* http://wiki.libsdl.org/SDL_Init * \sa SDL_Quit
* http://wiki.libsdl.org/SDL_Quit
*/ */
static int main_testInitQuitSubSystem(void *arg) static int main_testInitQuitSubSystem(void *arg)
{ {

52
test/testautomation_mouse.c
View File

@ -24,7 +24,7 @@ static int mouseStateCheck(Uint32 state)
} }
/** /**
* @brief Check call to SDL_GetMouseState * \brief Check call to SDL_GetMouseState
* *
*/ */
int mouse_getMouseState(void *arg) int mouse_getMouseState(void *arg)
@ -69,7 +69,7 @@ int mouse_getMouseState(void *arg)
} }
/** /**
* @brief Check call to SDL_GetRelativeMouseState * \brief Check call to SDL_GetRelativeMouseState
* *
*/ */
int mouse_getRelativeMouseState(void *arg) int mouse_getRelativeMouseState(void *arg)
@ -187,10 +187,10 @@ static SDL_Cursor *initArrowCursor(const char *image[])
} }
/** /**
* @brief Check call to SDL_CreateCursor and SDL_DestroyCursor * \brief Check call to SDL_CreateCursor and SDL_DestroyCursor
* *
* @sa http://wiki.libsdl.org/SDL_CreateCursor * \sa SDL_CreateCursor
* @sa http://wiki.libsdl.org/SDL_DestroyCursor * \sa SDL_DestroyCursor
*/ */
int mouse_createFreeCursor(void *arg) int mouse_createFreeCursor(void *arg)
{ {
@ -212,10 +212,10 @@ int mouse_createFreeCursor(void *arg)
} }
/** /**
* @brief Check call to SDL_CreateColorCursor and SDL_DestroyCursor * \brief Check call to SDL_CreateColorCursor and SDL_DestroyCursor
* *
* @sa http://wiki.libsdl.org/SDL_CreateColorCursor * \sa SDL_CreateColorCursor
* @sa http://wiki.libsdl.org/SDL_DestroyCursor * \sa SDL_DestroyCursor
*/ */
int mouse_createFreeColorCursor(void *arg) int mouse_createFreeColorCursor(void *arg)
{ {
@ -268,9 +268,9 @@ static void changeCursorVisibility(SDL_bool state)
} }
/** /**
* @brief Check call to SDL_ShowCursor * \brief Check call to SDL_ShowCursor
* *
* @sa http://wiki.libsdl.org/SDL_ShowCursor * \sa SDL_ShowCursor
*/ */
int mouse_showCursor(void *arg) int mouse_showCursor(void *arg)
{ {
@ -293,9 +293,9 @@ int mouse_showCursor(void *arg)
} }
/** /**
* @brief Check call to SDL_SetCursor * \brief Check call to SDL_SetCursor
* *
* @sa http://wiki.libsdl.org/SDL_SetCursor * \sa SDL_SetCursor
*/ */
int mouse_setCursor(void *arg) int mouse_setCursor(void *arg)
{ {
@ -325,9 +325,9 @@ int mouse_setCursor(void *arg)
} }
/** /**
* @brief Check call to SDL_GetCursor * \brief Check call to SDL_GetCursor
* *
* @sa http://wiki.libsdl.org/SDL_GetCursor * \sa SDL_GetCursor
*/ */
int mouse_getCursor(void *arg) int mouse_getCursor(void *arg)
{ {
@ -342,10 +342,10 @@ int mouse_getCursor(void *arg)
} }
/** /**
* @brief Check call to SDL_GetRelativeMouseMode and SDL_SetRelativeMouseMode * \brief Check call to SDL_GetRelativeMouseMode and SDL_SetRelativeMouseMode
* *
* @sa http://wiki.libsdl.org/SDL_GetRelativeMouseMode * \sa SDL_GetRelativeMouseMode
* @sa http://wiki.libsdl.org/SDL_SetRelativeMouseMode * \sa SDL_SetRelativeMouseMode
*/ */
int mouse_getSetRelativeMouseMode(void *arg) int mouse_getSetRelativeMouseMode(void *arg)
{ {
@ -412,7 +412,7 @@ static SDL_Window *createMouseSuiteTestWindow()
return window; return window;
} }
/* /**
* Destroy test window * Destroy test window
*/ */
static void destroyMouseSuiteTestWindow(SDL_Window *window) static void destroyMouseSuiteTestWindow(SDL_Window *window)
@ -425,9 +425,9 @@ static void destroyMouseSuiteTestWindow(SDL_Window *window)
} }
/** /**
* @brief Check call to SDL_WarpMouseInWindow * \brief Check call to SDL_WarpMouseInWindow
* *
* @sa http://wiki.libsdl.org/SDL_WarpMouseInWindow * \sa SDL_WarpMouseInWindow
*/ */
int mouse_warpMouseInWindow(void *arg) int mouse_warpMouseInWindow(void *arg)
{ {
@ -488,9 +488,9 @@ int mouse_warpMouseInWindow(void *arg)
} }
/** /**
* @brief Check call to SDL_GetMouseFocus * \brief Check call to SDL_GetMouseFocus
* *
* @sa http://wiki.libsdl.org/SDL_GetMouseFocus * \sa SDL_GetMouseFocus
*/ */
int mouse_getMouseFocus(void *arg) int mouse_getMouseFocus(void *arg)
{ {
@ -548,9 +548,9 @@ int mouse_getMouseFocus(void *arg)
} }
/** /**
* @brief Check call to SDL_GetDefaultCursor * \brief Check call to SDL_GetDefaultCursor
* *
* @sa http://wiki.libsdl.org/SDL_GetDefaultCursor * \sa SDL_GetDefaultCursor
*/ */
int mouse_getDefaultCursor(void *arg) int mouse_getDefaultCursor(void *arg)
{ {
@ -565,9 +565,9 @@ int mouse_getDefaultCursor(void *arg)
} }
/** /**
* @brief Check call to SDL_GetGlobalMouseState * \brief Check call to SDL_GetGlobalMouseState
* *
* @sa http://wiki.libsdl.org/SDL_GetGlobalMouseState * \sa SDL_GetGlobalMouseState
*/ */
int mouse_getGlobalMouseState(void *arg) int mouse_getGlobalMouseState(void *arg)
{ {

16
test/testautomation_pixels.c
View File

@ -104,10 +104,10 @@ const char *g_invalidPixelFormatsVerbose[] = {
/* Test case functions */ /* Test case functions */
/** /**
* @brief Call to SDL_CreatePixelFormat and SDL_DestroyPixelFormat * \brief Call to SDL_CreatePixelFormat and SDL_DestroyPixelFormat
* *
* @sa http://wiki.libsdl.org/SDL_CreatePixelFormat * \sa SDL_CreatePixelFormat
* @sa http://wiki.libsdl.org/SDL_DestroyPixelFormat * \sa SDL_DestroyPixelFormat
*/ */
int pixels_allocFreeFormat(void *arg) int pixels_allocFreeFormat(void *arg)
{ {
@ -200,9 +200,9 @@ int pixels_allocFreeFormat(void *arg)
} }
/** /**
* @brief Call to SDL_GetPixelFormatName * \brief Call to SDL_GetPixelFormatName
* *
* @sa http://wiki.libsdl.org/SDL_GetPixelFormatName * \sa SDL_GetPixelFormatName
*/ */
int pixels_getPixelFormatName(void *arg) int pixels_getPixelFormatName(void *arg)
{ {
@ -267,10 +267,10 @@ int pixels_getPixelFormatName(void *arg)
} }
/** /**
* @brief Call to SDL_CreatePalette and SDL_DestroyPalette * \brief Call to SDL_CreatePalette and SDL_DestroyPalette
* *
* @sa http://wiki.libsdl.org/SDL_CreatePalette * \sa SDL_CreatePalette
* @sa http://wiki.libsdl.org/SDL_DestroyPalette * \sa SDL_DestroyPalette
*/ */
int pixels_allocFreePalette(void *arg) int pixels_allocFreePalette(void *arg)
{ {

71
test/testautomation_platform.c
View File

@ -10,7 +10,7 @@
/* Helper functions */ /* Helper functions */
/** /**
* @brief Compare sizes of types. * \brief Compare sizes of types.
* *
* @note Watcom C flags these as Warning 201: "Unreachable code" if you just * @note Watcom C flags these as Warning 201: "Unreachable code" if you just
* compare them directly, so we push it through a function to keep the * compare them directly, so we push it through a function to keep the
@ -24,7 +24,7 @@ static int compareSizeOfType(size_t sizeoftype, size_t hardcodetype)
/* Test case functions */ /* Test case functions */
/** /**
* @brief Tests type sizes. * \brief Tests type sizes.
*/ */
int platform_testTypes(void *arg) int platform_testTypes(void *arg)
{ {
@ -46,7 +46,7 @@ int platform_testTypes(void *arg)
} }
/** /**
* @brief Tests platform endianness and SDL_SwapXY functions. * \brief Tests platform endianness and SDL_SwapXY functions.
*/ */
int platform_testEndianessAndSwap(void *arg) int platform_testEndianessAndSwap(void *arg)
{ {
@ -116,13 +116,12 @@ int platform_testEndianessAndSwap(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetXYZ() functions * \brief Tests SDL_GetXYZ() functions
* \sa * \sa SDL_GetPlatform
* http://wiki.libsdl.org/SDL_GetPlatform * \sa SDL_GetCPUCount
* http://wiki.libsdl.org/SDL_GetCPUCount * \sa SDL_GetRevision
* http://wiki.libsdl.org/SDL_GetCPUCacheLineSize * \sa SDL_GetCPUCacheLineSize
* http://wiki.libsdl.org/SDL_GetRevision
*/ */
int platform_testGetFunctions(void *arg) int platform_testGetFunctions(void *arg)
{ {
@ -161,18 +160,17 @@ int platform_testGetFunctions(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_HasXYZ() functions * \brief Tests SDL_HasXYZ() functions
* \sa * \sa SDL_HasAltiVec
* http://wiki.libsdl.org/SDL_HasAltiVec * \sa SDL_HasMMX
* http://wiki.libsdl.org/SDL_HasMMX * \sa SDL_HasRDTSC
* http://wiki.libsdl.org/SDL_HasRDTSC * \sa SDL_HasSSE
* http://wiki.libsdl.org/SDL_HasSSE * \sa SDL_HasSSE2
* http://wiki.libsdl.org/SDL_HasSSE2 * \sa SDL_HasSSE3
* http://wiki.libsdl.org/SDL_HasSSE3 * \sa SDL_HasSSE41
* http://wiki.libsdl.org/SDL_HasSSE41 * \sa SDL_HasSSE42
* http://wiki.libsdl.org/SDL_HasSSE42 * \sa SDL_HasAVX
* http://wiki.libsdl.org/SDL_HasAVX
*/ */
int platform_testHasFunctions(void *arg) int platform_testHasFunctions(void *arg)
{ {
@ -208,10 +206,9 @@ int platform_testHasFunctions(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetVersion * \brief Tests SDL_GetVersion
* \sa * \sa SDL_GetVersion
* http://wiki.libsdl.org/SDL_GetVersion
*/ */
int platform_testGetVersion(void *arg) int platform_testGetVersion(void *arg)
{ {
@ -232,7 +229,7 @@ int platform_testGetVersion(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_VERSION macro * \brief Tests SDL_VERSION macro
*/ */
int platform_testSDLVersion(void *arg) int platform_testSDLVersion(void *arg)
@ -254,7 +251,7 @@ int platform_testSDLVersion(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests default SDL_Init * \brief Tests default SDL_Init
*/ */
int platform_testDefaultInit(void *arg) int platform_testDefaultInit(void *arg)
@ -276,12 +273,11 @@ int platform_testDefaultInit(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_Get/Set/ClearError * \brief Tests SDL_Get/Set/ClearError
* \sa * \sa SDL_GetError
* http://wiki.libsdl.org/SDL_GetError * \sa SDL_SetError
* http://wiki.libsdl.org/SDL_SetError * \sa SDL_ClearError
* http://wiki.libsdl.org/SDL_ClearError
*/ */
int platform_testGetSetClearError(void *arg) int platform_testGetSetClearError(void *arg)
{ {
@ -328,10 +324,9 @@ int platform_testGetSetClearError(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_SetError with empty input * \brief Tests SDL_SetError with empty input
* \sa * \sa SDL_SetError
* http://wiki.libsdl.org/SDL_SetError
*/ */
int platform_testSetErrorEmptyInput(void *arg) int platform_testSetErrorEmptyInput(void *arg)
{ {
@ -370,10 +365,9 @@ int platform_testSetErrorEmptyInput(void *arg)
#pragma GCC diagnostic ignored "-Wformat-overflow" #pragma GCC diagnostic ignored "-Wformat-overflow"
#endif #endif
/* ! /**
* \brief Tests SDL_SetError with invalid input * \brief Tests SDL_SetError with invalid input
* \sa * \sa SDL_SetError
* http://wiki.libsdl.org/SDL_SetError
*/ */
int platform_testSetErrorInvalidInput(void *arg) int platform_testSetErrorInvalidInput(void *arg)
{ {
@ -454,10 +448,9 @@ int platform_testSetErrorInvalidInput(void *arg)
#pragma GCC diagnostic pop #pragma GCC diagnostic pop
#endif #endif
/* ! /**
* \brief Tests SDL_GetPowerInfo * \brief Tests SDL_GetPowerInfo
* \sa * \sa SDL_GetPowerInfo
* http://wiki.libsdl.org/SDL_GetPowerInfo
*/ */
int platform_testGetPowerInfo(void *arg) int platform_testGetPowerInfo(void *arg)
{ {

174
test/testautomation_rect.c
View File

@ -9,7 +9,7 @@
/* Helper functions */ /* Helper functions */
/* ! /**
* \brief Private helper to check SDL_GetRectAndLineIntersection results * \brief Private helper to check SDL_GetRectAndLineIntersection results
*/ */
static void validateIntersectRectAndLineResults( static void validateIntersectRectAndLineResults(
@ -36,11 +36,10 @@ static void validateIntersectRectAndLineResults(
/* Test case functions */ /* Test case functions */
/* ! /**
* \brief Tests SDL_GetRectAndLineIntersection() clipping cases * \brief Tests SDL_GetRectAndLineIntersection() clipping cases
* *
* \sa * \sa SDL_GetRectAndLineIntersection
* http://wiki.libsdl.org/SDL_GetRectAndLineIntersection
*/ */
int rect_testIntersectRectAndLine(void *arg) int rect_testIntersectRectAndLine(void *arg)
{ {
@ -106,11 +105,10 @@ int rect_testIntersectRectAndLine(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectAndLineIntersection() non-clipping case line inside * \brief Tests SDL_GetRectAndLineIntersection() non-clipping case line inside
* *
* \sa * \sa SDL_GetRectAndLineIntersection
* http://wiki.libsdl.org/SDL_GetRectAndLineIntersection
*/ */
int rect_testIntersectRectAndLineInside(void *arg) int rect_testIntersectRectAndLineInside(void *arg)
{ {
@ -172,11 +170,10 @@ int rect_testIntersectRectAndLineInside(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectAndLineIntersection() non-clipping cases outside * \brief Tests SDL_GetRectAndLineIntersection() non-clipping cases outside
* *
* \sa * \sa SDL_GetRectAndLineIntersection
* http://wiki.libsdl.org/SDL_GetRectAndLineIntersection
*/ */
int rect_testIntersectRectAndLineOutside(void *arg) int rect_testIntersectRectAndLineOutside(void *arg)
{ {
@ -226,11 +223,10 @@ int rect_testIntersectRectAndLineOutside(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectAndLineIntersection() with empty rectangle * \brief Tests SDL_GetRectAndLineIntersection() with empty rectangle
* *
* \sa * \sa SDL_GetRectAndLineIntersection
* http://wiki.libsdl.org/SDL_GetRectAndLineIntersection
*/ */
int rect_testIntersectRectAndLineEmpty(void *arg) int rect_testIntersectRectAndLineEmpty(void *arg)
{ {
@ -260,11 +256,10 @@ int rect_testIntersectRectAndLineEmpty(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Negative tests against SDL_GetRectAndLineIntersection() with invalid parameters * \brief Negative tests against SDL_GetRectAndLineIntersection() with invalid parameters
* *
* \sa * \sa SDL_GetRectAndLineIntersection
* http://wiki.libsdl.org/SDL_GetRectAndLineIntersection
*/ */
int rect_testIntersectRectAndLineParam(void *arg) int rect_testIntersectRectAndLineParam(void *arg)
{ {
@ -294,7 +289,7 @@ int rect_testIntersectRectAndLineParam(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Private helper to check SDL_HasRectIntersection results * \brief Private helper to check SDL_HasRectIntersection results
*/ */
static void validateHasIntersectionResults( static void validateHasIntersectionResults(
@ -317,7 +312,7 @@ static void validateHasIntersectionResults(
refRectB->x, refRectB->y, refRectB->w, refRectB->h); refRectB->x, refRectB->y, refRectB->w, refRectB->h);
} }
/* ! /**
* \brief Private helper to check SDL_GetRectIntersection results * \brief Private helper to check SDL_GetRectIntersection results
*/ */
static void validateIntersectRectResults( static void validateIntersectRectResults(
@ -336,7 +331,7 @@ static void validateIntersectRectResults(
} }
} }
/* ! /**
* \brief Private helper to check SDL_GetRectUnion results * \brief Private helper to check SDL_GetRectUnion results
*/ */
static void validateUnionRectResults( static void validateUnionRectResults(
@ -359,7 +354,7 @@ static void validateUnionRectResults(
expectedResult->x, expectedResult->y, expectedResult->w, expectedResult->h); expectedResult->x, expectedResult->y, expectedResult->w, expectedResult->h);
} }
/* ! /**
* \brief Private helper to check SDL_RectEmpty results * \brief Private helper to check SDL_RectEmpty results
*/ */
static void validateRectEmptyResults( static void validateRectEmptyResults(
@ -377,7 +372,7 @@ static void validateRectEmptyResults(
refRect->x, refRect->y, refRect->w, refRect->h); refRect->x, refRect->y, refRect->w, refRect->h);
} }
/* ! /**
* \brief Private helper to check SDL_RectsEqual results * \brief Private helper to check SDL_RectsEqual results
*/ */
static void validateRectEqualsResults( static void validateRectEqualsResults(
@ -400,7 +395,7 @@ static void validateRectEqualsResults(
refRectB->x, refRectB->y, refRectB->w, refRectB->h); refRectB->x, refRectB->y, refRectB->w, refRectB->h);
} }
/* ! /**
* \brief Private helper to check SDL_RectsEqualFloat results * \brief Private helper to check SDL_RectsEqualFloat results
*/ */
static void validateFRectEqualsResults( static void validateFRectEqualsResults(
@ -426,11 +421,10 @@ static void validateFRectEqualsResults(
refRectB->x, refRectB->y, refRectB->w, refRectB->h); refRectB->x, refRectB->y, refRectB->w, refRectB->h);
} }
/* ! /**
* \brief Tests SDL_GetRectIntersection() with B fully inside A * \brief Tests SDL_GetRectIntersection() with B fully inside A
* *
* \sa * \sa SDL_GetRectIntersection
* http://wiki.libsdl.org/SDL_GetRectIntersection
*/ */
int rect_testIntersectRectInside(void *arg) int rect_testIntersectRectInside(void *arg)
{ {
@ -454,11 +448,10 @@ int rect_testIntersectRectInside(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectIntersection() with B fully outside A * \brief Tests SDL_GetRectIntersection() with B fully outside A
* *
* \sa * \sa SDL_GetRectIntersection
* http://wiki.libsdl.org/SDL_GetRectIntersection
*/ */
int rect_testIntersectRectOutside(void *arg) int rect_testIntersectRectOutside(void *arg)
{ {
@ -482,11 +475,10 @@ int rect_testIntersectRectOutside(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectIntersection() with B partially intersecting A * \brief Tests SDL_GetRectIntersection() with B partially intersecting A
* *
* \sa * \sa SDL_GetRectIntersection
* http://wiki.libsdl.org/SDL_GetRectIntersection
*/ */
int rect_testIntersectRectPartial(void *arg) int rect_testIntersectRectPartial(void *arg)
{ {
@ -571,11 +563,10 @@ int rect_testIntersectRectPartial(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectIntersection() with 1x1 pixel sized rectangles * \brief Tests SDL_GetRectIntersection() with 1x1 pixel sized rectangles
* *
* \sa * \sa SDL_GetRectIntersection
* http://wiki.libsdl.org/SDL_GetRectIntersection
*/ */
int rect_testIntersectRectPoint(void *arg) int rect_testIntersectRectPoint(void *arg)
{ {
@ -618,11 +609,10 @@ int rect_testIntersectRectPoint(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectIntersection() with empty rectangles * \brief Tests SDL_GetRectIntersection() with empty rectangles
* *
* \sa * \sa SDL_GetRectIntersection
* http://wiki.libsdl.org/SDL_GetRectIntersection
*/ */
int rect_testIntersectRectEmpty(void *arg) int rect_testIntersectRectEmpty(void *arg)
{ {
@ -690,11 +680,10 @@ int rect_testIntersectRectEmpty(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Negative tests against SDL_GetRectIntersection() with invalid parameters * \brief Negative tests against SDL_GetRectIntersection() with invalid parameters
* *
* \sa * \sa SDL_GetRectIntersection
* http://wiki.libsdl.org/SDL_GetRectIntersection
*/ */
int rect_testIntersectRectParam(void *arg) int rect_testIntersectRectParam(void *arg)
{ {
@ -720,11 +709,10 @@ int rect_testIntersectRectParam(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_HasRectIntersection() with B fully inside A * \brief Tests SDL_HasRectIntersection() with B fully inside A
* *
* \sa * \sa SDL_HasRectIntersection
* http://wiki.libsdl.org/SDL_HasRectIntersection
*/ */
int rect_testHasIntersectionInside(void *arg) int rect_testHasIntersectionInside(void *arg)
{ {
@ -747,11 +735,10 @@ int rect_testHasIntersectionInside(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_HasRectIntersection() with B fully outside A * \brief Tests SDL_HasRectIntersection() with B fully outside A
* *
* \sa * \sa SDL_HasRectIntersection
* http://wiki.libsdl.org/SDL_HasRectIntersection
*/ */
int rect_testHasIntersectionOutside(void *arg) int rect_testHasIntersectionOutside(void *arg)
{ {
@ -774,11 +761,10 @@ int rect_testHasIntersectionOutside(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_HasRectIntersection() with B partially intersecting A * \brief Tests SDL_HasRectIntersection() with B partially intersecting A
* *
* \sa * \sa SDL_HasRectIntersection
* http://wiki.libsdl.org/SDL_HasRectIntersection
*/ */
int rect_testHasIntersectionPartial(void *arg) int rect_testHasIntersectionPartial(void *arg)
{ {
@ -841,11 +827,10 @@ int rect_testHasIntersectionPartial(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_HasRectIntersection() with 1x1 pixel sized rectangles * \brief Tests SDL_HasRectIntersection() with 1x1 pixel sized rectangles
* *
* \sa * \sa SDL_HasRectIntersection
* http://wiki.libsdl.org/SDL_HasRectIntersection
*/ */
int rect_testHasIntersectionPoint(void *arg) int rect_testHasIntersectionPoint(void *arg)
{ {
@ -887,11 +872,10 @@ int rect_testHasIntersectionPoint(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_HasRectIntersection() with empty rectangles * \brief Tests SDL_HasRectIntersection() with empty rectangles
* *
* \sa * \sa SDL_HasRectIntersection
* http://wiki.libsdl.org/SDL_HasRectIntersection
*/ */
int rect_testHasIntersectionEmpty(void *arg) int rect_testHasIntersectionEmpty(void *arg)
{ {
@ -945,11 +929,10 @@ int rect_testHasIntersectionEmpty(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Negative tests against SDL_HasRectIntersection() with invalid parameters * \brief Negative tests against SDL_HasRectIntersection() with invalid parameters
* *
* \sa * \sa SDL_HasRectIntersection
* http://wiki.libsdl.org/SDL_HasRectIntersection
*/ */
int rect_testHasIntersectionParam(void *arg) int rect_testHasIntersectionParam(void *arg)
{ {
@ -968,11 +951,10 @@ int rect_testHasIntersectionParam(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Test SDL_GetRectEnclosingPoints() without clipping * \brief Test SDL_GetRectEnclosingPoints() without clipping
* *
* \sa * \sa SDL_GetRectEnclosingPoints
* http://wiki.libsdl.org/SDL_GetRectEnclosingPoints
*/ */
int rect_testEnclosePoints(void *arg) int rect_testEnclosePoints(void *arg)
{ {
@ -1046,11 +1028,10 @@ int rect_testEnclosePoints(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Test SDL_GetRectEnclosingPoints() with repeated input points * \brief Test SDL_GetRectEnclosingPoints() with repeated input points
* *
* \sa * \sa SDL_GetRectEnclosingPoints
* http://wiki.libsdl.org/SDL_GetRectEnclosingPoints
*/ */
int rect_testEnclosePointsRepeatedInput(void *arg) int rect_testEnclosePointsRepeatedInput(void *arg)
{ {
@ -1130,11 +1111,10 @@ int rect_testEnclosePointsRepeatedInput(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Test SDL_GetRectEnclosingPoints() with clipping * \brief Test SDL_GetRectEnclosingPoints() with clipping
* *
* \sa * \sa SDL_GetRectEnclosingPoints
* http://wiki.libsdl.org/SDL_GetRectEnclosingPoints
*/ */
int rect_testEnclosePointsWithClipping(void *arg) int rect_testEnclosePointsWithClipping(void *arg)
{ {
@ -1237,11 +1217,10 @@ int rect_testEnclosePointsWithClipping(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Negative tests against SDL_GetRectEnclosingPoints() with invalid parameters * \brief Negative tests against SDL_GetRectEnclosingPoints() with invalid parameters
* *
* \sa * \sa SDL_GetRectEnclosingPoints
* http://wiki.libsdl.org/SDL_GetRectEnclosingPoints
*/ */
int rect_testEnclosePointsParam(void *arg) int rect_testEnclosePointsParam(void *arg)
{ {
@ -1265,11 +1244,10 @@ int rect_testEnclosePointsParam(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectUnion() where rect B is outside rect A * \brief Tests SDL_GetRectUnion() where rect B is outside rect A
* *
* \sa * \sa SDL_GetRectUnion
* http://wiki.libsdl.org/SDL_GetRectUnion
*/ */
int rect_testUnionRectOutside(void *arg) int rect_testUnionRectOutside(void *arg)
{ {
@ -1344,11 +1322,10 @@ int rect_testUnionRectOutside(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectUnion() where rect A or rect B are empty * \brief Tests SDL_GetRectUnion() where rect A or rect B are empty
* *
* \sa * \sa SDL_GetRectUnion
* http://wiki.libsdl.org/SDL_GetRectUnion
*/ */
int rect_testUnionRectEmpty(void *arg) int rect_testUnionRectEmpty(void *arg)
{ {
@ -1409,11 +1386,10 @@ int rect_testUnionRectEmpty(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_GetRectUnion() where rect B is inside rect A * \brief Tests SDL_GetRectUnion() where rect B is inside rect A
* *
* \sa * \sa SDL_GetRectUnion
* http://wiki.libsdl.org/SDL_GetRectUnion
*/ */
int rect_testUnionRectInside(void *arg) int rect_testUnionRectInside(void *arg)
{ {
@ -1481,11 +1457,10 @@ int rect_testUnionRectInside(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Negative tests against SDL_GetRectUnion() with invalid parameters * \brief Negative tests against SDL_GetRectUnion() with invalid parameters
* *
* \sa * \sa SDL_GetRectUnion
* http://wiki.libsdl.org/SDL_GetRectUnion
*/ */
int rect_testUnionRectParam(void *arg) int rect_testUnionRectParam(void *arg)
{ {
@ -1509,11 +1484,10 @@ int rect_testUnionRectParam(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_RectEmpty() with various inputs * \brief Tests SDL_RectEmpty() with various inputs
* *
* \sa * \sa SDL_RectEmpty
* http://wiki.libsdl.org/SDL_RectEmpty
*/ */
int rect_testRectEmpty(void *arg) int rect_testRectEmpty(void *arg)
{ {
@ -1552,11 +1526,10 @@ int rect_testRectEmpty(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Negative tests against SDL_RectEmpty() with invalid parameters * \brief Negative tests against SDL_RectEmpty() with invalid parameters
* *
* \sa * \sa SDL_RectEmpty
* http://wiki.libsdl.org/SDL_RectEmpty
*/ */
int rect_testRectEmptyParam(void *arg) int rect_testRectEmptyParam(void *arg)
{ {
@ -1569,11 +1542,10 @@ int rect_testRectEmptyParam(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_RectsEqual() with various inputs * \brief Tests SDL_RectsEqual() with various inputs
* *
* \sa * \sa SDL_RectsEqual
* http://wiki.libsdl.org/SDL_RectsEqual
*/ */
int rect_testRectEquals(void *arg) int rect_testRectEquals(void *arg)
{ {
@ -1599,11 +1571,10 @@ int rect_testRectEquals(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Negative tests against SDL_RectsEqual() with invalid parameters * \brief Negative tests against SDL_RectsEqual() with invalid parameters
* *
* \sa * \sa SDL_RectsEqual
* http://wiki.libsdl.org/SDL_RectsEqual
*/ */
int rect_testRectEqualsParam(void *arg) int rect_testRectEqualsParam(void *arg)
{ {
@ -1632,11 +1603,10 @@ int rect_testRectEqualsParam(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Tests SDL_RectsEqualFloat() with various inputs * \brief Tests SDL_RectsEqualFloat() with various inputs
* *
* \sa * \sa SDL_RectsEqualFloat
* http://wiki.libsdl.org/SDL_RectsEqualFloat
*/ */
int rect_testFRectEquals(void *arg) int rect_testFRectEquals(void *arg)
{ {
@ -1662,11 +1632,10 @@ int rect_testFRectEquals(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* \brief Negative tests against SDL_RectsEqualFloat() with invalid parameters * \brief Negative tests against SDL_RectsEqualFloat() with invalid parameters
* *
* \sa * \sa SDL_RectsEqualFloat
* http://wiki.libsdl.org/SDL_RectsEqualFloat
*/ */
int rect_testFRectEqualsParam(void *arg) int rect_testFRectEqualsParam(void *arg)
{ {
@ -1833,11 +1802,8 @@ static const SDLTest_TestCaseReference rectTest31 = {
(SDLTest_TestCaseFp)rect_testFRectEqualsParam, "rect_testFRectEqualsParam", "Negative tests against SDL_RectsEqualFloat with invalid parameters", TEST_ENABLED (SDLTest_TestCaseFp)rect_testFRectEqualsParam, "rect_testFRectEqualsParam", "Negative tests against SDL_RectsEqualFloat with invalid parameters", TEST_ENABLED
}; };
/* ! /**
* \brief Sequence of Rect test cases; functions that handle simple rectangles including overlaps and merges. * \brief Sequence of Rect test cases; functions that handle simple rectangles including overlaps and merges.
*
* \sa
* http://wiki.libsdl.org/CategoryRect
*/ */
static const SDLTest_TestCaseReference *rectTests[] = { static const SDLTest_TestCaseReference *rectTests[] = {
&rectTest1, &rectTest2, &rectTest3, &rectTest4, &rectTest5, &rectTest6, &rectTest7, &rectTest8, &rectTest9, &rectTest10, &rectTest11, &rectTest12, &rectTest13, &rectTest14, &rectTest1, &rectTest2, &rectTest3, &rectTest4, &rectTest5, &rectTest6, &rectTest7, &rectTest8, &rectTest9, &rectTest10, &rectTest11, &rectTest12, &rectTest13, &rectTest14,

135
test/testautomation_render.c
View File

@ -57,7 +57,7 @@ void InitCreateRenderer(void *arg)
} }
} }
/* /**
* Destroy renderer for tests * Destroy renderer for tests
*/ */
void CleanupDestroyRenderer(void *arg) void CleanupDestroyRenderer(void *arg)
@ -76,10 +76,9 @@ void CleanupDestroyRenderer(void *arg)
} }
/** /**
* @brief Tests call to SDL_GetNumRenderDrivers * \brief Tests call to SDL_GetNumRenderDrivers
* *
* \sa * \sa SDL_GetNumRenderDrivers
* http://wiki.libsdl.org/SDL_GetNumRenderDrivers
*/ */
int render_testGetNumRenderDrivers(void *arg) int render_testGetNumRenderDrivers(void *arg)
{ {
@ -90,12 +89,11 @@ int render_testGetNumRenderDrivers(void *arg)
} }
/** /**
* @brief Tests the SDL primitives for rendering. * \brief Tests the SDL primitives for rendering.
* *
* \sa * \sa SDL_SetRenderDrawColor
* http://wiki.libsdl.org/SDL_SetRenderDrawColor * \sa SDL_RenderFillRect
* http://wiki.libsdl.org/SDL_RenderFillRect * \sa SDL_RenderLine
* http://wiki.libsdl.org/SDL_RenderLine
* *
*/ */
int render_testPrimitives(void *arg) int render_testPrimitives(void *arg)
@ -201,12 +199,11 @@ int render_testPrimitives(void *arg)
} }
/** /**
* @brief Tests the SDL primitives with alpha for rendering. * \brief Tests the SDL primitives with alpha for rendering.
* *
* \sa * \sa SDL_SetRenderDrawColor
* http://wiki.libsdl.org/SDL_SetRenderDrawColor * \sa SDL_SetRenderDrawBlendMode
* http://wiki.libsdl.org/SDL_SetRenderDrawBlendMode * \sa SDL_RenderFillRect
* http://wiki.libsdl.org/SDL_RenderFillRect
*/ */
int render_testPrimitivesBlend(void *arg) int render_testPrimitivesBlend(void *arg)
{ {
@ -365,11 +362,10 @@ int render_testPrimitivesBlend(void *arg)
} }
/** /**
* @brief Tests some blitting routines. * \brief Tests some blitting routines.
* *
* \sa * \sa SDL_RenderTexture
* http://wiki.libsdl.org/SDL_RenderTexture * \sa SDL_DestroyTexture
* http://wiki.libsdl.org/SDL_DestroyTexture
*/ */
int render_testBlit(void *arg) int render_testBlit(void *arg)
{ {
@ -434,12 +430,11 @@ int render_testBlit(void *arg)
} }
/** /**
* @brief Blits doing color tests. * \brief Blits doing color tests.
* *
* \sa * \sa SDL_SetTextureColorMod
* http://wiki.libsdl.org/SDL_SetTextureColorMod * \sa SDL_RenderTexture
* http://wiki.libsdl.org/SDL_RenderTexture * \sa SDL_DestroyTexture
* http://wiki.libsdl.org/SDL_DestroyTexture
*/ */
int render_testBlitColor(void *arg) int render_testBlitColor(void *arg)
{ {
@ -510,12 +505,11 @@ int render_testBlitColor(void *arg)
} }
/** /**
* @brief Tests blitting with alpha. * \brief Tests blitting with alpha.
* *
* \sa * \sa SDL_SetTextureAlphaMod
* http://wiki.libsdl.org/SDL_SetTextureAlphaMod * \sa SDL_RenderTexture
* http://wiki.libsdl.org/SDL_RenderTexture * \sa SDL_DestroyTexture
* http://wiki.libsdl.org/SDL_DestroyTexture
*/ */
int render_testBlitAlpha(void *arg) int render_testBlitAlpha(void *arg)
{ {
@ -589,11 +583,10 @@ int render_testBlitAlpha(void *arg)
} }
/** /**
* @brief Tests a blend mode. * \brief Tests a blend mode.
* *
* \sa * \sa SDL_SetTextureBlendMode
* http://wiki.libsdl.org/SDL_SetTextureBlendMode * \sa SDL_RenderTexture
* http://wiki.libsdl.org/SDL_RenderTexture
*/ */
static void static void
testBlitBlendMode(SDL_Texture *tface, int mode) testBlitBlendMode(SDL_Texture *tface, int mode)
@ -642,13 +635,12 @@ testBlitBlendMode(SDL_Texture *tface, int mode)
} }
/** /**
* @brief Tests some more blitting routines. * \brief Tests some more blitting routines.
* *
* \sa * \sa SDL_SetTextureColorMod
* http://wiki.libsdl.org/SDL_SetTextureColorMod * \sa SDL_SetTextureAlphaMod
* http://wiki.libsdl.org/SDL_SetTextureAlphaMod * \sa SDL_SetTextureBlendMode
* http://wiki.libsdl.org/SDL_SetTextureBlendMode * \sa SDL_DestroyTexture
* http://wiki.libsdl.org/SDL_DestroyTexture
*/ */
int render_testBlitBlend(void *arg) int render_testBlitBlend(void *arg)
{ {
@ -802,7 +794,7 @@ int render_testBlitBlend(void *arg)
} }
/** /**
* @brief Test viewport * \brief Test viewport
*/ */
int render_testViewport(void *arg) int render_testViewport(void *arg)
{ {
@ -871,7 +863,7 @@ int render_testViewport(void *arg)
} }
/** /**
* @brief Test logical size * \brief Test logical size
*/ */
int render_testLogicalSize(void *arg) int render_testLogicalSize(void *arg)
{ {
@ -989,7 +981,7 @@ int render_testLogicalSize(void *arg)
/* Helper functions */ /* Helper functions */
/** /**
* @brief Checks to see if functionality is supported. Helper function. * \brief Checks to see if functionality is supported. Helper function.
*/ */
static int static int
isSupported(int code) isSupported(int code)
@ -998,11 +990,10 @@ isSupported(int code)
} }
/** /**
* @brief Test to see if we can vary the draw color. Helper function. * \brief Test to see if we can vary the draw color. Helper function.
* *
* \sa * \sa SDL_SetRenderDrawColor
* http://wiki.libsdl.org/SDL_SetRenderDrawColor * \sa SDL_GetRenderDrawColor
* http://wiki.libsdl.org/SDL_GetRenderDrawColor
*/ */
static int static int
hasDrawColor(void) hasDrawColor(void)
@ -1040,11 +1031,10 @@ hasDrawColor(void)
} }
/** /**
* @brief Test to see if we can vary the blend mode. Helper function. * \brief Test to see if we can vary the blend mode. Helper function.
* *
* \sa * \sa SDL_SetRenderDrawBlendMode
* http://wiki.libsdl.org/SDL_SetRenderDrawBlendMode * \sa SDL_GetRenderDrawBlendMode
* http://wiki.libsdl.org/SDL_GetRenderDrawBlendMode
*/ */
static int static int
hasBlendModes(void) hasBlendModes(void)
@ -1108,10 +1098,9 @@ hasBlendModes(void)
} }
/** /**
* @brief Loads the test image 'Face' as texture. Helper function. * \brief Loads the test image 'Face' as texture. Helper function.
* *
* \sa * \sa SDL_CreateTextureFromSurface
* http://wiki.libsdl.org/SDL_CreateTextureFromSurface
*/ */
static SDL_Texture * static SDL_Texture *
loadTestFace(void) loadTestFace(void)
@ -1135,12 +1124,11 @@ loadTestFace(void)
} }
/** /**
* @brief Test to see if can set texture color mode. Helper function. * \brief Test to see if can set texture color mode. Helper function.
* *
* \sa * \sa SDL_SetTextureColorMod
* http://wiki.libsdl.org/SDL_SetTextureColorMod * \sa SDL_GetTextureColorMod
* http://wiki.libsdl.org/SDL_GetTextureColorMod * \sa SDL_DestroyTexture
* http://wiki.libsdl.org/SDL_DestroyTexture
*/ */
static int static int
hasTexColor(void) hasTexColor(void)
@ -1179,12 +1167,11 @@ hasTexColor(void)
} }
/** /**
* @brief Test to see if we can vary the alpha of the texture. Helper function. * \brief Test to see if we can vary the alpha of the texture. Helper function.
* *
* \sa * \sa SDL_SetTextureAlphaMod
* http://wiki.libsdl.org/SDL_SetTextureAlphaMod * \sa SDL_GetTextureAlphaMod
* http://wiki.libsdl.org/SDL_GetTextureAlphaMod * \sa SDL_DestroyTexture
* http://wiki.libsdl.org/SDL_DestroyTexture
*/ */
static int static int
hasTexAlpha(void) hasTexAlpha(void)
@ -1223,15 +1210,14 @@ hasTexAlpha(void)
} }
/** /**
* @brief Compares screen pixels with image pixels. Helper function. * \brief Compares screen pixels with image pixels. Helper function.
* *
* @param referenceSurface Image to compare against. * \param referenceSurface Image to compare against.
* @param allowable_error allowed difference from the reference image * \param allowable_error allowed difference from the reference image
* *
* \sa * \sa SDL_RenderReadPixels
* http://wiki.libsdl.org/SDL_RenderReadPixels * \sa SDL_CreateSurfaceFrom
* http://wiki.libsdl.org/SDL_CreateSurfaceFrom * \sa SDL_DestroySurface
* http://wiki.libsdl.org/SDL_DestroySurface
*/ */
static void static void
compare(SDL_Surface *referenceSurface, int allowable_error) compare(SDL_Surface *referenceSurface, int allowable_error)
@ -1270,13 +1256,12 @@ compare(SDL_Surface *referenceSurface, int allowable_error)
} }
/** /**
* @brief Clears the screen. Helper function. * \brief Clears the screen. Helper function.
* *
* \sa * \sa SDL_SetRenderDrawColor
* http://wiki.libsdl.org/SDL_SetRenderDrawColor * \sa SDL_RenderClear
* http://wiki.libsdl.org/SDL_RenderClear * \sa SDL_RenderPresent
* http://wiki.libsdl.org/SDL_RenderPresent * \sa SDL_SetRenderDrawBlendMode
* http://wiki.libsdl.org/SDL_SetRenderDrawBlendMode
*/ */
static int static int
clearScreen(void) clearScreen(void)

61
test/testautomation_rwops.c
View File

@ -89,11 +89,10 @@ void RWopsTearDown(void *arg)
} }
/** /**
* @brief Makes sure parameters work properly. Local helper function. * \brief Makes sure parameters work properly. Local helper function.
* *
* \sa * \sa SDL_RWseek
* http://wiki.libsdl.org/SDL_RWseek * \sa SDL_RWread
* http://wiki.libsdl.org/SDL_RWread
*/ */
static void testGenericRWopsValidations(SDL_RWops *rw, int write) static void testGenericRWopsValidations(SDL_RWops *rw, int write)
{ {
@ -167,10 +166,10 @@ static void testGenericRWopsValidations(SDL_RWops *rw, int write)
(int)i); (int)i);
} }
/* ! /**
* Negative test for SDL_RWFromFile parameters * Negative test for SDL_RWFromFile parameters
* *
* \sa http://wiki.libsdl.org/SDL_RWFromFile * \sa SDL_RWFromFile
* *
*/ */
int rwops_testParamNegative(void) int rwops_testParamNegative(void)
@ -214,10 +213,10 @@ int rwops_testParamNegative(void)
} }
/** /**
* @brief Tests opening from memory. * \brief Tests opening from memory.
* *
* \sa http://wiki.libsdl.org/SDL_RWFromMem * \sa SDL_RWFromMem
* \sa http://wiki.libsdl.org/SDL_RWClose * \sa SDL_RWClose
*/ */
int rwops_testMem(void) int rwops_testMem(void)
{ {
@ -253,11 +252,10 @@ int rwops_testMem(void)
} }
/** /**
* @brief Tests opening from memory. * \brief Tests opening from memory.
* *
* \sa * \sa SDL_RWFromConstMem
* http://wiki.libsdl.org/SDL_RWFromConstMem * \sa SDL_RWClose
* http://wiki.libsdl.org/SDL_RWClose
*/ */
int rwops_testConstMem(void) int rwops_testConstMem(void)
{ {
@ -289,11 +287,10 @@ int rwops_testConstMem(void)
} }
/** /**
* @brief Tests reading from file. * \brief Tests reading from file.
* *
* \sa * \sa SDL_RWFromFile
* http://wiki.libsdl.org/SDL_RWFromFile * \sa SDL_RWClose
* http://wiki.libsdl.org/SDL_RWClose
*/ */
int rwops_testFileRead(void) int rwops_testFileRead(void)
{ {
@ -337,11 +334,10 @@ int rwops_testFileRead(void)
} }
/** /**
* @brief Tests writing from file. * \brief Tests writing from file.
* *
* \sa * \sa SDL_RWFromFile
* http://wiki.libsdl.org/SDL_RWFromFile * \sa SDL_RWClose
* http://wiki.libsdl.org/SDL_RWClose
*/ */
int rwops_testFileWrite(void) int rwops_testFileWrite(void)
{ {
@ -385,10 +381,10 @@ int rwops_testFileWrite(void)
} }
/** /**
* @brief Tests alloc and free RW context. * \brief Tests alloc and free RW context.
* *
* \sa http://wiki.libsdl.org/SDL_CreateRW * \sa SDL_CreateRW
* \sa http://wiki.libsdl.org/SDL_DestroyRW * \sa SDL_DestroyRW
*/ */
int rwops_testAllocFree(void) int rwops_testAllocFree(void)
{ {
@ -413,10 +409,10 @@ int rwops_testAllocFree(void)
} }
/** /**
* @brief Compare memory and file reads * \brief Compare memory and file reads
* *
* \sa http://wiki.libsdl.org/SDL_RWFromMem * \sa SDL_RWFromMem
* \sa http://wiki.libsdl.org/SDL_RWFromFile * \sa SDL_RWFromFile
*/ */
int rwops_testCompareRWFromMemWithRWFromFile(void) int rwops_testCompareRWFromMemWithRWFromFile(void)
{ {
@ -476,13 +472,12 @@ int rwops_testCompareRWFromMemWithRWFromFile(void)
} }
/** /**
* @brief Tests writing and reading from file using endian aware functions. * \brief Tests writing and reading from file using endian aware functions.
* *
* \sa * \sa SDL_RWFromFile
* http://wiki.libsdl.org/SDL_RWFromFile * \sa SDL_RWClose
* http://wiki.libsdl.org/SDL_RWClose * \sa SDL_ReadBE16
* http://wiki.libsdl.org/SDL_ReadBE16 * \sa SDL_WriteBE16
* http://wiki.libsdl.org/SDL_WriteBE16
*/ */
int rwops_testFileWriteReadEndian(void) int rwops_testFileWriteReadEndian(void)
{ {

46
test/testautomation_sdltest.c
View File

@ -11,7 +11,7 @@
/* Test case functions */ /* Test case functions */
/** /**
* @brief Calls to SDLTest_GenerateRunSeed() * \brief Calls to SDLTest_GenerateRunSeed()
*/ */
int sdltest_generateRunSeed(void *arg) int sdltest_generateRunSeed(void *arg)
{ {
@ -41,7 +41,7 @@ int sdltest_generateRunSeed(void *arg)
} }
/** /**
* @brief Calls to SDLTest_GetFuzzerInvocationCount() * \brief Calls to SDLTest_GetFuzzerInvocationCount()
*/ */
int sdltest_getFuzzerInvocationCount(void *arg) int sdltest_getFuzzerInvocationCount(void *arg)
{ {
@ -63,7 +63,7 @@ int sdltest_getFuzzerInvocationCount(void *arg)
} }
/** /**
* @brief Calls to random number generators * \brief Calls to random number generators
*/ */
int sdltest_randomNumber(void *arg) int sdltest_randomNumber(void *arg)
{ {
@ -129,8 +129,8 @@ int sdltest_randomNumber(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* /**
* @brief Calls to random boundary number generators for Uint8 * \brief Calls to random boundary number generators for Uint8
*/ */
int sdltest_randomBoundaryNumberUint8(void *arg) int sdltest_randomBoundaryNumberUint8(void *arg)
{ {
@ -238,8 +238,8 @@ int sdltest_randomBoundaryNumberUint8(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* /**
* @brief Calls to random boundary number generators for Uint16 * \brief Calls to random boundary number generators for Uint16
*/ */
int sdltest_randomBoundaryNumberUint16(void *arg) int sdltest_randomBoundaryNumberUint16(void *arg)
{ {
@ -347,8 +347,8 @@ int sdltest_randomBoundaryNumberUint16(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* /**
* @brief Calls to random boundary number generators for Uint32 * \brief Calls to random boundary number generators for Uint32
*/ */
int sdltest_randomBoundaryNumberUint32(void *arg) int sdltest_randomBoundaryNumberUint32(void *arg)
{ {
@ -456,8 +456,8 @@ int sdltest_randomBoundaryNumberUint32(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* /**
* @brief Calls to random boundary number generators for Uint64 * \brief Calls to random boundary number generators for Uint64
*/ */
int sdltest_randomBoundaryNumberUint64(void *arg) int sdltest_randomBoundaryNumberUint64(void *arg)
{ {
@ -565,8 +565,8 @@ int sdltest_randomBoundaryNumberUint64(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* /**
* @brief Calls to random boundary number generators for Sint8 * \brief Calls to random boundary number generators for Sint8
*/ */
int sdltest_randomBoundaryNumberSint8(void *arg) int sdltest_randomBoundaryNumberSint8(void *arg)
{ {
@ -674,8 +674,8 @@ int sdltest_randomBoundaryNumberSint8(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* /**
* @brief Calls to random boundary number generators for Sint16 * \brief Calls to random boundary number generators for Sint16
*/ */
int sdltest_randomBoundaryNumberSint16(void *arg) int sdltest_randomBoundaryNumberSint16(void *arg)
{ {
@ -783,8 +783,8 @@ int sdltest_randomBoundaryNumberSint16(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* /**
* @brief Calls to random boundary number generators for Sint32 * \brief Calls to random boundary number generators for Sint32
*/ */
int sdltest_randomBoundaryNumberSint32(void *arg) int sdltest_randomBoundaryNumberSint32(void *arg)
{ {
@ -899,8 +899,8 @@ int sdltest_randomBoundaryNumberSint32(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* /**
* @brief Calls to random boundary number generators for Sint64 * \brief Calls to random boundary number generators for Sint64
*/ */
int sdltest_randomBoundaryNumberSint64(void *arg) int sdltest_randomBoundaryNumberSint64(void *arg)
{ {
@ -1009,7 +1009,7 @@ int sdltest_randomBoundaryNumberSint64(void *arg)
} }
/** /**
* @brief Calls to SDLTest_RandomIntegerInRange * \brief Calls to SDLTest_RandomIntegerInRange
*/ */
int sdltest_randomIntegerInRange(void *arg) int sdltest_randomIntegerInRange(void *arg)
{ {
@ -1083,7 +1083,7 @@ int sdltest_randomIntegerInRange(void *arg)
} }
/** /**
* @brief Calls to SDLTest_RandomAsciiString * \brief Calls to SDLTest_RandomAsciiString
*/ */
int sdltest_randomAsciiString(void *arg) int sdltest_randomAsciiString(void *arg)
{ {
@ -1115,7 +1115,7 @@ int sdltest_randomAsciiString(void *arg)
} }
/** /**
* @brief Calls to SDLTest_RandomAsciiStringWithMaximumLength * \brief Calls to SDLTest_RandomAsciiStringWithMaximumLength
*/ */
int sdltest_randomAsciiStringWithMaximumLength(void *arg) int sdltest_randomAsciiStringWithMaximumLength(void *arg)
{ {
@ -1167,7 +1167,7 @@ int sdltest_randomAsciiStringWithMaximumLength(void *arg)
} }
/** /**
* @brief Calls to SDLTest_RandomAsciiStringOfSize * \brief Calls to SDLTest_RandomAsciiStringOfSize
*/ */
int sdltest_randomAsciiStringOfSize(void *arg) int sdltest_randomAsciiStringOfSize(void *arg)
{ {

10
test/testautomation_stdlib.c
View File

@ -7,7 +7,7 @@
/* Test case functions */ /* Test case functions */
/** /**
* @brief Call to SDL_strlcpy * \brief Call to SDL_strlcpy
*/ */
#undef SDL_strlcpy #undef SDL_strlcpy
int stdlib_strlcpy(void *arg) int stdlib_strlcpy(void *arg)
@ -42,7 +42,7 @@ int stdlib_strlcpy(void *arg)
#endif #endif
/** /**
* @brief Call to SDL_snprintf * \brief Call to SDL_snprintf
*/ */
#undef SDL_snprintf #undef SDL_snprintf
int stdlib_snprintf(void *arg) int stdlib_snprintf(void *arg)
@ -209,7 +209,7 @@ int stdlib_snprintf(void *arg)
#endif #endif
/** /**
* @brief Call to SDL_getenv and SDL_setenv * \brief Call to SDL_getenv and SDL_setenv
*/ */
int stdlib_getsetenv(void *arg) int stdlib_getsetenv(void *arg)
{ {
@ -352,7 +352,7 @@ int stdlib_getsetenv(void *arg)
#endif #endif
/** /**
* @brief Call to SDL_sscanf * \brief Call to SDL_sscanf
*/ */
#undef SDL_sscanf #undef SDL_sscanf
int stdlib_sscanf(void *arg) int stdlib_sscanf(void *arg)
@ -445,7 +445,7 @@ int stdlib_sscanf(void *arg)
#endif #endif
/** /**
* @brief Call to SDL_aligned_alloc * \brief Call to SDL_aligned_alloc
*/ */
int stdlib_aligned_alloc(void *arg) int stdlib_aligned_alloc(void *arg)
{ {

24
test/testautomation_surface.c
View File

@ -213,7 +213,7 @@ static void AssertFileExist(const char *filename)
/* Test case functions */ /* Test case functions */
/** /**
* @brief Tests sprite saving and loading * \brief Tests sprite saving and loading
*/ */
int surface_testSaveLoadBitmap(void *arg) int surface_testSaveLoadBitmap(void *arg)
{ {
@ -259,7 +259,7 @@ int surface_testSaveLoadBitmap(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* Tests surface conversion. * Tests surface conversion.
*/ */
int surface_testSurfaceConversion(void *arg) int surface_testSurfaceConversion(void *arg)
@ -299,7 +299,7 @@ int surface_testSurfaceConversion(void *arg)
return TEST_COMPLETED; return TEST_COMPLETED;
} }
/* ! /**
* Tests surface conversion across all pixel formats. * Tests surface conversion across all pixel formats.
*/ */
int surface_testCompleteSurfaceConversion(void *arg) int surface_testCompleteSurfaceConversion(void *arg)
@ -390,7 +390,7 @@ int surface_testCompleteSurfaceConversion(void *arg)
} }
/** /**
* @brief Tests sprite loading. A failure case. * \brief Tests sprite loading. A failure case.
*/ */
int surface_testLoadFailure(void *arg) int surface_testLoadFailure(void *arg)
{ {
@ -401,7 +401,7 @@ int surface_testLoadFailure(void *arg)
} }
/** /**
* @brief Tests some blitting routines. * \brief Tests some blitting routines.
*/ */
int surface_testBlit(void *arg) int surface_testBlit(void *arg)
{ {
@ -423,7 +423,7 @@ int surface_testBlit(void *arg)
} }
/** /**
* @brief Tests some blitting routines with color mod * \brief Tests some blitting routines with color mod
*/ */
int surface_testBlitColorMod(void *arg) int surface_testBlitColorMod(void *arg)
{ {
@ -445,7 +445,7 @@ int surface_testBlitColorMod(void *arg)
} }
/** /**
* @brief Tests some blitting routines with alpha mod * \brief Tests some blitting routines with alpha mod
*/ */
int surface_testBlitAlphaMod(void *arg) int surface_testBlitAlphaMod(void *arg)
{ {
@ -467,7 +467,7 @@ int surface_testBlitAlphaMod(void *arg)
} }
/** /**
* @brief Tests some more blitting routines. * \brief Tests some more blitting routines.
*/ */
int surface_testBlitBlendNone(void *arg) int surface_testBlitBlendNone(void *arg)
{ {
@ -489,7 +489,7 @@ int surface_testBlitBlendNone(void *arg)
} }
/** /**
* @brief Tests some more blitting routines. * \brief Tests some more blitting routines.
*/ */
int surface_testBlitBlendBlend(void *arg) int surface_testBlitBlendBlend(void *arg)
{ {
@ -511,7 +511,7 @@ int surface_testBlitBlendBlend(void *arg)
} }
/** /**
* @brief Tests some more blitting routines. * \brief Tests some more blitting routines.
*/ */
int surface_testBlitBlendAdd(void *arg) int surface_testBlitBlendAdd(void *arg)
{ {
@ -533,7 +533,7 @@ int surface_testBlitBlendAdd(void *arg)
} }
/** /**
* @brief Tests some more blitting routines. * \brief Tests some more blitting routines.
*/ */
int surface_testBlitBlendMod(void *arg) int surface_testBlitBlendMod(void *arg)
{ {
@ -555,7 +555,7 @@ int surface_testBlitBlendMod(void *arg)
} }
/** /**
* @brief Tests some more blitting routines with loop * \brief Tests some more blitting routines with loop
*/ */
int surface_testBlitBlendLoop(void *arg) int surface_testBlitBlendLoop(void *arg)
{ {

2
test/testautomation_syswm.c
View File

@ -8,7 +8,7 @@
/* Test case functions */ /* Test case functions */
/** /**
* @brief Call to SDL_GetWindowWMInfo * \brief Call to SDL_GetWindowWMInfo
*/ */
int syswm_getWindowWMInfo(void *arg) int syswm_getWindowWMInfo(void *arg)
{ {

8
test/testautomation_timer.c
View File

@ -29,7 +29,7 @@ static void timerSetUp(void *arg)
/* Test case functions */ /* Test case functions */
/** /**
* @brief Call to SDL_GetPerformanceCounter * \brief Call to SDL_GetPerformanceCounter
*/ */
int timer_getPerformanceCounter(void *arg) int timer_getPerformanceCounter(void *arg)
{ {
@ -43,7 +43,7 @@ int timer_getPerformanceCounter(void *arg)
} }
/** /**
* @brief Call to SDL_GetPerformanceFrequency * \brief Call to SDL_GetPerformanceFrequency
*/ */
int timer_getPerformanceFrequency(void *arg) int timer_getPerformanceFrequency(void *arg)
{ {
@ -57,7 +57,7 @@ int timer_getPerformanceFrequency(void *arg)
} }
/** /**
* @brief Call to SDL_Delay and SDL_GetTicks * \brief Call to SDL_Delay and SDL_GetTicks
*/ */
int timer_delayAndGetTicks(void *arg) int timer_delayAndGetTicks(void *arg)
{ {
@ -112,7 +112,7 @@ static Uint32 SDLCALL timerTestCallback(Uint32 interval, void *param)
} }
/** /**
* @brief Call to SDL_AddTimer and SDL_RemoveTimer * \brief Call to SDL_AddTimer and SDL_RemoveTimer
*/ */
int timer_addRemoveTimer(void *arg) int timer_addRemoveTimer(void *arg)
{ {

68
test/testautomation_video.c
View File

@ -6,7 +6,7 @@
/* Private helpers */ /* Private helpers */
/* /**
* Create a test window * Create a test window
*/ */
static SDL_Window *createVideoSuiteTestWindow(const char *title) static SDL_Window *createVideoSuiteTestWindow(const char *title)
@ -29,7 +29,7 @@ static SDL_Window *createVideoSuiteTestWindow(const char *title)
return window; return window;
} }
/* /**
* Destroy test window * Destroy test window
*/ */
static void destroyVideoSuiteTestWindow(SDL_Window *window) static void destroyVideoSuiteTestWindow(SDL_Window *window)
@ -44,7 +44,7 @@ static void destroyVideoSuiteTestWindow(SDL_Window *window)
/* Test case functions */ /* Test case functions */
/** /**
* @brief Enable and disable screensaver while checking state * \brief Enable and disable screensaver while checking state
*/ */
int video_enableDisableScreensaver(void *arg) int video_enableDisableScreensaver(void *arg)
{ {
@ -95,7 +95,7 @@ int video_enableDisableScreensaver(void *arg)
} }
/** /**
* @brief Tests the functionality of the SDL_CreateWindow function using different positions * \brief Tests the functionality of the SDL_CreateWindow function using different positions
*/ */
int video_createWindowVariousPositions(void *arg) int video_createWindowVariousPositions(void *arg)
{ {
@ -177,7 +177,7 @@ int video_createWindowVariousPositions(void *arg)
} }
/** /**
* @brief Tests the functionality of the SDL_CreateWindow function using different sizes * \brief Tests the functionality of the SDL_CreateWindow function using different sizes
*/ */
int video_createWindowVariousSizes(void *arg) int video_createWindowVariousSizes(void *arg)
{ {
@ -233,7 +233,7 @@ int video_createWindowVariousSizes(void *arg)
} }
/** /**
* @brief Tests the functionality of the SDL_CreateWindow function using different flags * \brief Tests the functionality of the SDL_CreateWindow function using different flags
*/ */
int video_createWindowVariousFlags(void *arg) int video_createWindowVariousFlags(void *arg)
{ {
@ -307,7 +307,7 @@ int video_createWindowVariousFlags(void *arg)
} }
/** /**
* @brief Tests the functionality of the SDL_GetWindowFlags function * \brief Tests the functionality of the SDL_GetWindowFlags function
*/ */
int video_getWindowFlags(void *arg) int video_getWindowFlags(void *arg)
{ {
@ -334,7 +334,7 @@ int video_getWindowFlags(void *arg)
} }
/** /**
* @brief Tests the functionality of the SDL_GetFullscreenDisplayModes function * \brief Tests the functionality of the SDL_GetFullscreenDisplayModes function
*/ */
int video_getFullscreenDisplayModes(void *arg) int video_getFullscreenDisplayModes(void *arg)
{ {
@ -363,7 +363,7 @@ int video_getFullscreenDisplayModes(void *arg)
} }
/** /**
* @brief Tests the functionality of the SDL_GetClosestFullscreenDisplayMode function against current resolution * \brief Tests the functionality of the SDL_GetClosestFullscreenDisplayMode function against current resolution
*/ */
int video_getClosestDisplayModeCurrentResolution(void *arg) int video_getClosestDisplayModeCurrentResolution(void *arg)
{ {
@ -408,7 +408,7 @@ int video_getClosestDisplayModeCurrentResolution(void *arg)
} }
/** /**
* @brief Tests the functionality of the SDL_GetClosestFullscreenDisplayMode function against random resolution * \brief Tests the functionality of the SDL_GetClosestFullscreenDisplayMode function against random resolution
*/ */
int video_getClosestDisplayModeRandomResolution(void *arg) int video_getClosestDisplayModeRandomResolution(void *arg)
{ {
@ -446,9 +446,9 @@ int video_getClosestDisplayModeRandomResolution(void *arg)
} }
/** /**
* @brief Tests call to SDL_GetWindowFullscreenMode * \brief Tests call to SDL_GetWindowFullscreenMode
* *
* @sa http://wiki.libsdl.org/SDL_GetWindowFullscreenMode * \sa SDL_GetWindowFullscreenMode
*/ */
int video_getWindowDisplayMode(void *arg) int video_getWindowDisplayMode(void *arg)
{ {
@ -490,9 +490,9 @@ static void checkInvalidWindowError()
} }
/** /**
* @brief Tests call to SDL_GetWindowFullscreenMode with invalid input * \brief Tests call to SDL_GetWindowFullscreenMode with invalid input
* *
* @sa http://wiki.libsdl.org/SDL_GetWindowFullscreenMode * \sa SDL_GetWindowFullscreenMode
*/ */
int video_getWindowDisplayModeNegative(void *arg) int video_getWindowDisplayModeNegative(void *arg)
{ {
@ -578,10 +578,10 @@ static void setAndCheckWindowKeyboardGrabState(SDL_Window *window, SDL_bool desi
} }
/** /**
* @brief Tests keyboard and mouse grab support * \brief Tests keyboard and mouse grab support
* *
* @sa http://wiki.libsdl.org/SDL_GetWindowGrab * \sa SDL_GetWindowGrab
* @sa http://wiki.libsdl.org/SDL_SetWindowGrab * \sa SDL_SetWindowGrab
*/ */
int video_getSetWindowGrab(void *arg) int video_getSetWindowGrab(void *arg)
{ {
@ -721,10 +721,10 @@ int video_getSetWindowGrab(void *arg)
} }
/** /**
* @brief Tests call to SDL_GetWindowID and SDL_GetWindowFromID * \brief Tests call to SDL_GetWindowID and SDL_GetWindowFromID
* *
* @sa http://wiki.libsdl.org/SDL_GetWindowID * \sa SDL_GetWindowID
* @sa http://wiki.libsdl.org/SDL_SetWindowFromID * \sa SDL_SetWindowFromID
*/ */
int video_getWindowId(void *arg) int video_getWindowId(void *arg)
{ {
@ -778,9 +778,9 @@ int video_getWindowId(void *arg)
} }
/** /**
* @brief Tests call to SDL_GetWindowPixelFormat * \brief Tests call to SDL_GetWindowPixelFormat
* *
* @sa http://wiki.libsdl.org/SDL_GetWindowPixelFormat * \sa SDL_GetWindowPixelFormat
*/ */
int video_getWindowPixelFormat(void *arg) int video_getWindowPixelFormat(void *arg)
{ {
@ -813,10 +813,10 @@ int video_getWindowPixelFormat(void *arg)
} }
/** /**
* @brief Tests call to SDL_GetWindowPosition and SDL_SetWindowPosition * \brief Tests call to SDL_GetWindowPosition and SDL_SetWindowPosition
* *
* @sa http://wiki.libsdl.org/SDL_GetWindowPosition * \sa SDL_GetWindowPosition
* @sa http://wiki.libsdl.org/SDL_SetWindowPosition * \sa SDL_SetWindowPosition
*/ */
int video_getSetWindowPosition(void *arg) int video_getSetWindowPosition(void *arg)
{ {
@ -959,10 +959,10 @@ static void checkInvalidParameterError()
} }
/** /**
* @brief Tests call to SDL_GetWindowSize and SDL_SetWindowSize * \brief Tests call to SDL_GetWindowSize and SDL_SetWindowSize
* *
* @sa http://wiki.libsdl.org/SDL_GetWindowSize * \sa SDL_GetWindowSize
* @sa http://wiki.libsdl.org/SDL_SetWindowSize * \sa SDL_SetWindowSize
*/ */
int video_getSetWindowSize(void *arg) int video_getSetWindowSize(void *arg)
{ {
@ -1128,7 +1128,7 @@ int video_getSetWindowSize(void *arg)
} }
/** /**
* @brief Tests call to SDL_GetWindowMinimumSize and SDL_SetWindowMinimumSize * \brief Tests call to SDL_GetWindowMinimumSize and SDL_SetWindowMinimumSize
* *
*/ */
int video_getSetWindowMinimumSize(void *arg) int video_getSetWindowMinimumSize(void *arg)
@ -1271,7 +1271,7 @@ int video_getSetWindowMinimumSize(void *arg)
} }
/** /**
* @brief Tests call to SDL_GetWindowMaximumSize and SDL_SetWindowMaximumSize * \brief Tests call to SDL_GetWindowMaximumSize and SDL_SetWindowMaximumSize
* *
*/ */
int video_getSetWindowMaximumSize(void *arg) int video_getSetWindowMaximumSize(void *arg)
@ -1409,10 +1409,10 @@ int video_getSetWindowMaximumSize(void *arg)
} }
/** /**
* @brief Tests call to SDL_SetWindowData and SDL_GetWindowData * \brief Tests call to SDL_SetWindowData and SDL_GetWindowData
* *
* @sa http://wiki.libsdl.org/SDL_SetWindowData * \sa SDL_SetWindowData
* @sa http://wiki.libsdl.org/SDL_GetWindowData * \sa SDL_GetWindowData
*/ */
int video_getSetWindowData(void *arg) int video_getSetWindowData(void *arg)
{ {
@ -1625,7 +1625,7 @@ cleanup:
} }
/** /**
* @brief Tests the functionality of the SDL_WINDOWPOS_CENTERED_DISPLAY along with SDL_WINDOW_FULLSCREEN. * \brief Tests the functionality of the SDL_WINDOWPOS_CENTERED_DISPLAY along with SDL_WINDOW_FULLSCREEN.
* *
* Espeically useful when run on a multi-monitor system with different DPI scales per monitor, * Espeically useful when run on a multi-monitor system with different DPI scales per monitor,
* to test that the window size is maintained when moving between monitors. * to test that the window size is maintained when moving between monitors.

2
test/testdrawchessboard.c
View File

@ -9,7 +9,7 @@
including commercial applications, and to alter it and redistribute it including commercial applications, and to alter it and redistribute it
freely. freely.
This file is created by : Nitin Jain (nitin.j4@samsung.com) This file is created by : Nitin Jain (nitin.j4\samsung.com)
*/ */
/* Sample program: Draw a Chess Board by using SDL_CreateSoftwareRenderer API */ /* Sample program: Draw a Chess Board by using SDL_CreateSoftwareRenderer API */

8
test/testgles2.c
View File

@ -113,7 +113,7 @@ quit(int rc)
} \ } \
} }
/* /**
* Simulates desktop's glRotatef. The matrix is returned in column-major * Simulates desktop's glRotatef. The matrix is returned in column-major
* order. * order.
*/ */
@ -154,7 +154,7 @@ rotate_matrix(float angle, float x, float y, float z, float *r)
} }
} }
/* /**
* Simulates gluPerspectiveMatrix * Simulates gluPerspectiveMatrix
*/ */
static void static void
@ -177,7 +177,7 @@ perspective_matrix(float fovy, float aspect, float znear, float zfar, float *r)
r[15] = 0.0f; r[15] = 0.0f;
} }
/* /**
* Multiplies lhs by rhs and writes out to r. All matrices are 4x4 and column * Multiplies lhs by rhs and writes out to r. All matrices are 4x4 and column
* major. In-place multiplication is supported. * major. In-place multiplication is supported.
*/ */
@ -202,7 +202,7 @@ multiply_matrix(const float *lhs, const float *rhs, float *r)
} }
} }
/* /**
* Create shader, load in source, compile, dump debug as necessary. * Create shader, load in source, compile, dump debug as necessary.
* *
* shader: Pointer to return created shader ID. * shader: Pointer to return created shader ID.

2
test/testgles2_sdf.c
View File

@ -115,7 +115,7 @@ quit(int rc)
} \ } \
} }
/* /**
* Create shader, load in source, compile, dump debug as necessary. * Create shader, load in source, compile, dump debug as necessary.
* *
* shader: Pointer to return created shader ID. * shader: Pointer to return created shader ID.

17
test/testhaptic.c
View File

@ -11,14 +11,11 @@ Redistribution and use in source and binary forms, with or without modification,
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/*
* includes
*/
#include <stdlib.h>
#include <SDL3/SDL.h> #include <SDL3/SDL.h>
#include <SDL3/SDL_main.h> #include <SDL3/SDL_main.h>
#include <stdlib.h>
static SDL_Haptic *haptic; static SDL_Haptic *haptic;
/* /*
@ -28,9 +25,9 @@ static void abort_execution(void);
static void HapticPrintSupported(SDL_Haptic *); static void HapticPrintSupported(SDL_Haptic *);
/** /**
* @brief The entry point of this force feedback demo. * \brief The entry point of this force feedback demo.
* @param[in] argc Number of arguments. * \param[in] argc Number of arguments.
* @param[in] argv Array of argc arguments. * \param[in] argv Array of argc arguments.
*/ */
int main(int argc, char **argv) int main(int argc, char **argv)
{ {
@ -288,7 +285,7 @@ int main(int argc, char **argv)
return 0; return 0;
} }
/* /**
* Cleans up a bit. * Cleans up a bit.
*/ */
static void static void
@ -302,7 +299,7 @@ abort_execution(void)
exit(1); exit(1);
} }
/* /**
* Displays information about the haptic device. * Displays information about the haptic device.
*/ */
static void static void

2
test/testlock.c
View File

@ -25,7 +25,7 @@ static SDL_threadID mainthread;
static SDL_Thread *threads[6]; static SDL_Thread *threads[6];
static SDL_atomic_t doterminate; static SDL_atomic_t doterminate;
/* /**
* SDL_Quit() shouldn't be used with atexit() directly because * SDL_Quit() shouldn't be used with atexit() directly because
* calling conventions may differ... * calling conventions may differ...
*/ */

9
test/testrumble.c
View File

@ -22,18 +22,15 @@ Redistribution and use in source and binary forms, with or without modification,
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/*
* includes
*/
#include <SDL3/SDL.h> #include <SDL3/SDL.h>
#include <SDL3/SDL_main.h> #include <SDL3/SDL_main.h>
static SDL_Haptic *haptic; static SDL_Haptic *haptic;
/** /**
* @brief The entry point of this force feedback demo. * \brief The entry point of this force feedback demo.
* @param[in] argc Number of arguments. * \param[in] argc Number of arguments.
* @param[in] argv Array of argc arguments. * \param[in] argv Array of argc arguments.
*/ */
int main(int argc, char **argv) int main(int argc, char **argv)
{ {

6
test/testutils.c
View File

@ -6,7 +6,7 @@ SPDX-License-Identifier: Zlib
#include "testutils.h" #include "testutils.h"
/* /**
* Return the absolute path to def in the SDL_GetBasePath() if possible, or * Return the absolute path to def in the SDL_GetBasePath() if possible, or
* the relative path to def on platforms that don't have a working * the relative path to def on platforms that don't have a working
* SDL_GetBasePath(). Free the result with SDL_free. * SDL_GetBasePath(). Free the result with SDL_free.
@ -53,7 +53,7 @@ GetNearbyFilename(const char *file)
return path; return path;
} }
/* /**
* If user_specified is non-NULL, return a copy of it. Free with SDL_free. * If user_specified is non-NULL, return a copy of it. Free with SDL_free.
* *
* Otherwise, return the absolute path to def in the SDL_GetBasePath() if * Otherwise, return the absolute path to def in the SDL_GetBasePath() if
@ -78,7 +78,7 @@ GetResourceFilename(const char *user_specified, const char *def)
} }
} }
/* /**
* Load the .bmp file whose name is file, from the SDL_GetBasePath() if * Load the .bmp file whose name is file, from the SDL_GetBasePath() if
* possible or the current working directory if not. * possible or the current working directory if not.
* *