gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Remove Doxygen \brief tags.

Browse Source 
Doxygen and the wiki bridge don't need them; they'll both just use the first
line/sentence instead.

Fixes #8446.
This commit is contained in:
Ryan C. Gordon
2023-11-06 10:26:06 -05:00
parent c132295ad7
commit c53843a961
104 changed files with 669 additions and 667 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
test/testautomation_audio.c
View File

@@ -59,7 +59,7 @@ static SDL_AudioDeviceID g_audio_id = -1;
/* Test case functions */
/**
* \brief Stop and restart audio subsystem
* Stop and restart audio subsystem
*
* \sa SDL_QuitSubSystem
* \sa SDL_InitSubSystem
@@ -77,7 +77,7 @@ static int audio_quitInitAudioSubSystem(void *arg)
}
/**
* \brief Start and stop audio directly
* Start and stop audio directly
*
* \sa SDL_InitAudio
* \sa SDL_QuitAudio
@@ -133,7 +133,7 @@ static int audio_initQuitAudio(void *arg)
}
/**
* \brief Start, open, close and stop audio
* Start, open, close and stop audio
*
* \sa SDL_InitAudio
* \sa SDL_OpenAudioDevice
@@ -219,7 +219,7 @@ static int audio_initOpenCloseQuitAudio(void *arg)
}
/**
* \brief Pause and unpause audio
* Pause and unpause audio
*
* \sa SDL_PauseAudioDevice
* \sa SDL_PlayAudioDevice
@@ -340,7 +340,7 @@ static int audio_pauseUnpauseAudio(void *arg)
}
/**
* \brief Enumerate and name available audio devices (output and capture).
* Enumerate and name available audio devices (output and capture).
*
* \sa SDL_GetNumAudioDevices
* \sa SDL_GetAudioDeviceName
@@ -381,7 +381,7 @@ static int audio_enumerateAndNameAudioDevices(void *arg)
}
/**
* \brief Negative tests around enumeration and naming of audio devices.
* Negative tests around enumeration and naming of audio devices.
*
* \sa SDL_GetNumAudioDevices
* \sa SDL_GetAudioDeviceName
@@ -392,7 +392,7 @@ static int audio_enumerateAndNameAudioDevicesNegativeTests(void *arg)
}
/**
* \brief Checks available audio driver names.
* Checks available audio driver names.
*
* \sa SDL_GetNumAudioDrivers
* \sa SDL_GetAudioDriver
@@ -423,7 +423,7 @@ static int audio_printAudioDrivers(void *arg)
}
/**
* \brief Checks current audio driver name with initialized audio.
* Checks current audio driver name with initialized audio.
*
* \sa SDL_GetCurrentAudioDriver
*/
@@ -470,7 +470,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_AUDIO_F32LE_FORMAT, SDL_AUDIO_F32LE == (SDL_AUDIO_BI
SDL_COMPILE_TIME_ASSERT(SDL_AUDIO_F32BE_FORMAT, SDL_AUDIO_F32BE == (SDL_AUDIO_F32LE | SDL_AUDIO_MASK_BIG_ENDIAN));
/**
* \brief Builds various audio conversion structures
* Builds various audio conversion structures
*
* \sa SDL_CreateAudioStream
*/
@@ -539,7 +539,7 @@ static int audio_buildAudioStream(void *arg)
}
/**
* \brief Checks calls with invalid input to SDL_CreateAudioStream
* Checks calls with invalid input to SDL_CreateAudioStream
*
* \sa SDL_CreateAudioStream
*/
@@ -619,7 +619,7 @@ static int audio_buildAudioStreamNegative(void *arg)
}
/**
* \brief Checks current audio status.
* Checks current audio status.
*
* \sa SDL_GetAudioDeviceStatus
*/
@@ -629,7 +629,7 @@ static int audio_getAudioStatus(void *arg)
}
/**
* \brief Opens, checks current audio status, and closes a device.
* Opens, checks current audio status, and closes a device.
*
* \sa SDL_GetAudioStatus
*/
@@ -639,7 +639,7 @@ static int audio_openCloseAndGetAudioStatus(void *arg)
}
/**
* \brief Locks and unlocks open audio device.
* Locks and unlocks open audio device.
*
* \sa SDL_LockAudioDevice
* \sa SDL_UnlockAudioDevice
@@ -650,7 +650,7 @@ static int audio_lockUnlockOpenAudioDevice(void *arg)
}
/**
* \brief Convert audio using various conversion structures
* Convert audio using various conversion structures
*
* \sa SDL_CreateAudioStream
*/
@@ -784,7 +784,7 @@ static int audio_convertAudio(void *arg)
}
/**
* \brief Opens, checks current connected status, and closes a device.
* Opens, checks current connected status, and closes a device.
*
* \sa SDL_AudioDeviceConnected
*/
@@ -806,7 +806,7 @@ static double sine_wave_sample(const Sint64 idx, const Sint64 rate, const Sint64
}
/**
* \brief Check signal-to-noise ratio and maximum error of audio resampling.
* Check signal-to-noise ratio and maximum error of audio resampling.
*
* \sa https://wiki.libsdl.org/SDL_CreateAudioStream
* \sa https://wiki.libsdl.org/SDL_DestroyAudioStream
@@ -963,7 +963,7 @@ static int audio_resampleLoss(void *arg)
}
/**
* \brief Check accuracy converting between audio formats.
* Check accuracy converting between audio formats.
*
* \sa SDL_ConvertAudioSamples
*/
@@ -1098,7 +1098,7 @@ static int audio_convertAccuracy(void *arg)
}
/**
* \brief Check accuracy when switching between formats
* Check accuracy when switching between formats
*
* \sa SDL_SetAudioStreamFormat
*/

6
test/testautomation_clipboard.c
View File

@@ -74,7 +74,7 @@ static void ClipboardCleanupCallback(void *userdata)
/* Test case functions */
/**
* \brief End-to-end test of SDL_xyzClipboardData functions
* End-to-end test of SDL_xyzClipboardData functions
* \sa SDL_HasClipboardData
* \sa SDL_GetClipboardData
* \sa SDL_SetClipboardData
@@ -373,7 +373,7 @@ static int clipboard_testClipboardDataFunctions(void *arg)
}
/**
* \brief End-to-end test of SDL_xyzClipboardText functions
* End-to-end test of SDL_xyzClipboardText functions
* \sa SDL_HasClipboardText
* \sa SDL_GetClipboardText
* \sa SDL_SetClipboardText
@@ -457,7 +457,7 @@ static int clipboard_testClipboardTextFunctions(void *arg)
}
/**
* \brief End-to-end test of SDL_xyzPrimarySelectionText functions
* End-to-end test of SDL_xyzPrimarySelectionText functions
* \sa SDL_HasPrimarySelectionText
* \sa SDL_GetPrimarySelectionText
* \sa SDL_SetPrimarySelectionText

6
test/testautomation_events.c
View File

@@ -38,7 +38,7 @@ static int SDLCALL events_sampleNullEventFilter(void *userdata, SDL_Event *event
}
/**
* \brief Test pumping and peeking events.
* Test pumping and peeking events.
*
* \sa SDL_PumpEvents
* \sa SDL_PollEvent
@@ -75,7 +75,7 @@ static int events_pushPumpAndPollUserevent(void *arg)
}
/**
* \brief Adds and deletes an event watch function with NULL userdata
* Adds and deletes an event watch function with NULL userdata
*
* \sa SDL_AddEventWatch
* \sa SDL_DelEventWatch
@@ -125,7 +125,7 @@ static int events_addDelEventWatch(void *arg)
}
/**
* \brief Adds and deletes an event watch function with userdata
* Adds and deletes an event watch function with userdata
*
* \sa SDL_AddEventWatch
* \sa SDL_DelEventWatch

4
test/testautomation_guid.c
View File

@@ -70,7 +70,7 @@ upper_lower_to_bytestring(Uint8 *out, Uint64 upper, Uint64 lower)
/* Test case functions */
/**
* \brief Check String-to-GUID conversion
* Check String-to-GUID conversion
*
* \sa SDL_GUIDFromString
*/
@@ -95,7 +95,7 @@ TestGuidFromString(void *arg)
}
/**
* \brief Check GUID-to-String conversion
* Check GUID-to-String conversion
*
* \sa SDL_GUIDToString
*/

4
test/testautomation_hints.c
View File

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

22
test/testautomation_images.c
View File

@@ -528,7 +528,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlit = {
};
/**
* \brief Returns the Blit test image as SDL_Surface.
* Returns the Blit test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageBlit(void)
{
@@ -1000,7 +1000,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitColor = {
};
/**
* \brief Returns the BlitColor test image as SDL_Surface.
* Returns the BlitColor test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageBlitColor(void)
{
@@ -1635,7 +1635,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitAlpha = {
};
/**
* \brief Returns the BlitAlpha test image as SDL_Surface.
* Returns the BlitAlpha test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageBlitAlpha(void)
{
@@ -2203,7 +2203,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlendAdd = {
};
/**
* \brief Returns the BlitBlendAdd test image as SDL_Surface.
* Returns the BlitBlendAdd test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageBlitBlendAdd(void)
{
@@ -2792,7 +2792,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlend = {
};
/**
* \brief Returns the BlitBlend test image as SDL_Surface.
* Returns the BlitBlend test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageBlitBlend(void)
{
@@ -3211,7 +3211,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlendMod = {
};
/**
* \brief Returns the BlitBlendMod test image as SDL_Surface.
* Returns the BlitBlendMod test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageBlitBlendMod(void)
{
@@ -4013,7 +4013,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlendNone = {
};
/**
* \brief Returns the BlitBlendNone test image as SDL_Surface.
* Returns the BlitBlendNone test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageBlitBlendNone(void)
{
@@ -4547,7 +4547,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlendAll = {
};
/**
* \brief Returns the BlitBlendAll test image as SDL_Surface.
* Returns the BlitBlendAll test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageBlitBlendAll(void)
{
@@ -4758,7 +4758,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageFace = {
};
/**
* \brief Returns the Face test image as SDL_Surface.
* Returns the Face test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImageFace(void)
{
@@ -5251,7 +5251,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imagePrimitives = {
};
/**
* \brief Returns the Primitives test image as SDL_Surface.
* Returns the Primitives test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImagePrimitives(void)
{
@@ -5916,7 +5916,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imagePrimitivesBlend = {
};
/**
* \brief Returns the PrimitivesBlend test image as SDL_Surface.
* Returns the PrimitivesBlend test image as SDL_Surface.
*/
SDL_Surface *SDLTest_ImagePrimitivesBlend(void)
{

8
test/testautomation_intrinsics.c
View File

@@ -86,7 +86,7 @@ static void free_arrays(void *dest, void *a, void *b) {
}
/**
* \brief Verify element-wise addition of 2 int arrays.
* Verify element-wise addition of 2 int arrays.
*/
static void verify_ints_addition(const Sint32 *dest, const Sint32 *a, const Sint32 *b, size_t size, const char *desc) {
size_t i;
@@ -106,7 +106,7 @@ static void verify_ints_addition(const Sint32 *dest, const Sint32 *a, const Sint
}
/**
* \brief Verify element-wise multiplication of 2 int arrays.
* Verify element-wise multiplication of 2 int arrays.
*/
static void verify_ints_multiplication(const Sint32 *dest, const Sint32 *a, const Sint32 *b, size_t size, const char *desc) {
size_t i;
@@ -126,7 +126,7 @@ static void verify_ints_multiplication(const Sint32 *dest, const Sint32 *a, cons
}
/**
* \brief Verify element-wise addition of 2 float arrays.
* Verify element-wise addition of 2 float arrays.
*/
static void verify_floats_addition(const float *dest, const float *a, const float *b, size_t size, const char *desc) {
size_t i;
@@ -147,7 +147,7 @@ static void verify_floats_addition(const float *dest, const float *a, const floa
}
/**
* \brief Verify element-wise addition of 2 double arrays.
* Verify element-wise addition of 2 double arrays.
*/
static void verify_doubles_addition(const double *dest, const double *a, const double *b, size_t size, const char *desc) {
size_t i;

2
test/testautomation_joystick.c
View File

@@ -12,7 +12,7 @@
/* Test case functions */
/**
* \brief Check virtual joystick creation
* Check virtual joystick creation
*
* \sa SDL_AttachVirtualJoystickEx
*/

28
test/testautomation_keyboard.c
View File

@@ -11,7 +11,7 @@
/* Test case functions */
/**
* \brief Check call to SDL_GetKeyboardState with and without numkeys reference.
* Check call to SDL_GetKeyboardState with and without numkeys reference.
*
* \sa SDL_GetKeyboardState
*/
@@ -36,7 +36,7 @@ static int keyboard_getKeyboardState(void *arg)
}
/**
* \brief Check call to SDL_GetKeyboardFocus
* Check call to SDL_GetKeyboardFocus
*
* \sa SDL_GetKeyboardFocus
*/
@@ -50,7 +50,7 @@ static int keyboard_getKeyboardFocus(void *arg)
}
/**
* \brief Check call to SDL_GetKeyFromName for known, unknown and invalid name.
* Check call to SDL_GetKeyFromName for known, unknown and invalid name.
*
* \sa SDL_GetKeyFromName
*/
@@ -115,7 +115,7 @@ static void checkInvalidScancodeError(void)
}
/**
* \brief Check call to SDL_GetKeyFromScancode
* Check call to SDL_GetKeyFromScancode
*
* \sa SDL_GetKeyFromScancode
*/
@@ -153,7 +153,7 @@ static int keyboard_getKeyFromScancode(void *arg)
}
/**
* \brief Check call to SDL_GetKeyName
* Check call to SDL_GetKeyName
*
* \sa SDL_GetKeyName
*/
@@ -208,7 +208,7 @@ static int keyboard_getKeyName(void *arg)
}
/**
* \brief SDL_GetScancodeName negative cases
* SDL_GetScancodeName negative cases
*
* \sa SDL_GetScancodeName
*/
@@ -234,7 +234,7 @@ static int keyboard_getScancodeNameNegative(void *arg)
}
/**
* \brief SDL_GetKeyName negative cases
* SDL_GetKeyName negative cases
*
* \sa SDL_GetKeyName
*/
@@ -270,7 +270,7 @@ static int keyboard_getKeyNameNegative(void *arg)
}
/**
* \brief Check call to SDL_GetModState and SDL_SetModState
* Check call to SDL_GetModState and SDL_SetModState
*
* \sa SDL_GetModState
* \sa SDL_SetModState
@@ -329,7 +329,7 @@ static int keyboard_getSetModState(void *arg)
}
/**
* \brief Check call to SDL_StartTextInput and SDL_StopTextInput
* Check call to SDL_StartTextInput and SDL_StopTextInput
*
* \sa SDL_StartTextInput
* \sa SDL_StopTextInput
@@ -375,7 +375,7 @@ static void testSetTextInputRect(SDL_Rect refRect)
}
/**
* \brief Check call to SDL_SetTextInputRect
* Check call to SDL_SetTextInputRect
*
* \sa SDL_SetTextInputRect
*/
@@ -454,7 +454,7 @@ static int keyboard_setTextInputRect(void *arg)
}
/**
* \brief Check call to SDL_SetTextInputRect with invalid data
* Check call to SDL_SetTextInputRect with invalid data
*
* \sa SDL_SetTextInputRect
*/
@@ -491,7 +491,7 @@ static int keyboard_setTextInputRectNegative(void *arg)
}
/**
* \brief Check call to SDL_GetScancodeFromKey
* Check call to SDL_GetScancodeFromKey
*
* \sa SDL_GetScancodeFromKey
* \sa SDL_Keycode
@@ -514,7 +514,7 @@ static int keyboard_getScancodeFromKey(void *arg)
}
/**
* \brief Check call to SDL_GetScancodeFromName
* Check call to SDL_GetScancodeFromName
*
* \sa SDL_GetScancodeFromName
* \sa SDL_Keycode
@@ -585,7 +585,7 @@ static void checkInvalidNameError(void)
}
/**
* \brief Check call to SDL_GetScancodeFromName with invalid data
* Check call to SDL_GetScancodeFromName with invalid data
*
* \sa SDL_GetScancodeFromName
* \sa SDL_Keycode

2
test/testautomation_main.c
View File

@@ -11,7 +11,7 @@
#include "testautomation_suites.h"
/**
* \brief Tests SDL_InitSubSystem() and SDL_QuitSubSystem()
* Tests SDL_InitSubSystem() and SDL_QuitSubSystem()
* \sa SDL_Init
* \sa SDL_Quit
*/

10
test/testautomation_math.c
View File

@@ -62,7 +62,7 @@ typedef double(SDLCALL *d_to_d_func)(double);
typedef double(SDLCALL *dd_to_d_func)(double, double);
/**
* \brief Runs all the cases on a given function with a signature double -> double.
* Runs all the cases on a given function with a signature double -> double.
* The result is expected to be exact.
*
* \param func_name a printable name for the tested function.
@@ -88,7 +88,7 @@ helper_dtod(const char *func_name, d_to_d_func func,
}
/**
* \brief Runs all the cases on a given function with a signature double -> double.
* Runs all the cases on a given function with a signature double -> double.
* Checks if the result between expected +/- EPSILON.
*
* \param func_name a printable name for the tested function.
@@ -117,7 +117,7 @@ helper_dtod_inexact(const char *func_name, d_to_d_func func,
}
/**
* \brief Runs all the cases on a given function with a signature
* Runs all the cases on a given function with a signature
* (double, double) -> double. The result is expected to be exact.
*
* \param func_name a printable name for the tested function.
@@ -143,7 +143,7 @@ helper_ddtod(const char *func_name, dd_to_d_func func,
}
/**
* \brief Runs all the cases on a given function with a signature
* Runs all the cases on a given function with a signature
* (double, double) -> double. Checks if the result between expected +/- EPSILON.
*
* \param func_name a printable name for the tested function.
@@ -172,7 +172,7 @@ helper_ddtod_inexact(const char *func_name, dd_to_d_func func,
}
/**
* \brief Runs a range of values on a given function with a signature double -> double
* Runs a range of values on a given function with a signature double -> double
*
* This function is only meant to test functions that returns the input value if it is
* integral: f(x) -> x for x in N.

24
test/testautomation_mouse.c
View File

@@ -25,7 +25,7 @@ static int mouseStateCheck(Uint32 state)
}
/**
* \brief Check call to SDL_GetMouseState
* Check call to SDL_GetMouseState
*
*/
static int mouse_getMouseState(void *arg)
@@ -70,7 +70,7 @@ static int mouse_getMouseState(void *arg)
}
/**
* \brief Check call to SDL_GetRelativeMouseState
* Check call to SDL_GetRelativeMouseState
*
*/
static int mouse_getRelativeMouseState(void *arg)
@@ -188,7 +188,7 @@ static SDL_Cursor *initArrowCursor(const char *image[])
}
/**
* \brief Check call to SDL_CreateCursor and SDL_DestroyCursor
* Check call to SDL_CreateCursor and SDL_DestroyCursor
*
* \sa SDL_CreateCursor
* \sa SDL_DestroyCursor
@@ -213,7 +213,7 @@ static int mouse_createFreeCursor(void *arg)
}
/**
* \brief Check call to SDL_CreateColorCursor and SDL_DestroyCursor
* Check call to SDL_CreateColorCursor and SDL_DestroyCursor
*
* \sa SDL_CreateColorCursor
* \sa SDL_DestroyCursor
@@ -269,7 +269,7 @@ static void changeCursorVisibility(SDL_bool state)
}
/**
* \brief Check call to SDL_ShowCursor
* Check call to SDL_ShowCursor
*
* \sa SDL_ShowCursor
*/
@@ -294,7 +294,7 @@ static int mouse_showCursor(void *arg)
}
/**
* \brief Check call to SDL_SetCursor
* Check call to SDL_SetCursor
*
* \sa SDL_SetCursor
*/
@@ -326,7 +326,7 @@ static int mouse_setCursor(void *arg)
}
/**
* \brief Check call to SDL_GetCursor
* Check call to SDL_GetCursor
*
* \sa SDL_GetCursor
*/
@@ -343,7 +343,7 @@ static int mouse_getCursor(void *arg)
}
/**
* \brief Check call to SDL_GetRelativeMouseMode and SDL_SetRelativeMouseMode
* Check call to SDL_GetRelativeMouseMode and SDL_SetRelativeMouseMode
*
* \sa SDL_GetRelativeMouseMode
* \sa SDL_SetRelativeMouseMode
@@ -426,7 +426,7 @@ static void destroyMouseSuiteTestWindow(SDL_Window *window)
}
/**
* \brief Check call to SDL_WarpMouseInWindow
* Check call to SDL_WarpMouseInWindow
*
* \sa SDL_WarpMouseInWindow
*/
@@ -489,7 +489,7 @@ static int mouse_warpMouseInWindow(void *arg)
}
/**
* \brief Check call to SDL_GetMouseFocus
* Check call to SDL_GetMouseFocus
*
* \sa SDL_GetMouseFocus
*/
@@ -555,7 +555,7 @@ static int mouse_getMouseFocus(void *arg)
}
/**
* \brief Check call to SDL_GetDefaultCursor
* Check call to SDL_GetDefaultCursor
*
* \sa SDL_GetDefaultCursor
*/
@@ -572,7 +572,7 @@ static int mouse_getDefaultCursor(void *arg)
}
/**
* \brief Check call to SDL_GetGlobalMouseState
* Check call to SDL_GetGlobalMouseState
*
* \sa SDL_GetGlobalMouseState
*/

6
test/testautomation_pixels.c
View File

@@ -111,7 +111,7 @@ static const char *g_invalidPixelFormatsVerbose[] = {
/* Test case functions */
/**
* \brief Call to SDL_CreatePixelFormat and SDL_DestroyPixelFormat
* Call to SDL_CreatePixelFormat and SDL_DestroyPixelFormat
*
* \sa SDL_CreatePixelFormat
* \sa SDL_DestroyPixelFormat
@@ -204,7 +204,7 @@ static int pixels_allocFreeFormat(void *arg)
}
/**
* \brief Call to SDL_GetPixelFormatName
* Call to SDL_GetPixelFormatName
*
* \sa SDL_GetPixelFormatName
*/
@@ -271,7 +271,7 @@ static int pixels_getPixelFormatName(void *arg)
}
/**
* \brief Call to SDL_CreatePalette and SDL_DestroyPalette
* Call to SDL_CreatePalette and SDL_DestroyPalette
*
* \sa SDL_CreatePalette
* \sa SDL_DestroyPalette

24
test/testautomation_platform.c
View File

@@ -11,7 +11,7 @@
/* Helper functions */
/**
* \brief Compare sizes of types.
* Compare sizes of types.
*
* @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
@@ -25,7 +25,7 @@ static int compareSizeOfType(size_t sizeoftype, size_t hardcodetype)
/* Test case functions */
/**
* \brief Tests type sizes.
* Tests type sizes.
*/
static int platform_testTypes(void *arg)
{
@@ -47,7 +47,7 @@ static int platform_testTypes(void *arg)
}
/**
* \brief Tests platform endianness and SDL_SwapXY functions.
* Tests platform endianness and SDL_SwapXY functions.
*/
static int platform_testEndianessAndSwap(void *arg)
{
@@ -118,7 +118,7 @@ static int platform_testEndianessAndSwap(void *arg)
}
/**
* \brief Tests SDL_GetXYZ() functions
* Tests SDL_GetXYZ() functions
* \sa SDL_GetPlatform
* \sa SDL_GetCPUCount
* \sa SDL_GetRevision
@@ -162,7 +162,7 @@ static int platform_testGetFunctions(void *arg)
}
/**
* \brief Tests SDL_HasXYZ() functions
* Tests SDL_HasXYZ() functions
* \sa SDL_HasAltiVec
* \sa SDL_HasMMX
* \sa SDL_HasSSE
@@ -204,7 +204,7 @@ static int platform_testHasFunctions(void *arg)
}
/**
* \brief Tests SDL_GetVersion
* Tests SDL_GetVersion
* \sa SDL_GetVersion
*/
static int platform_testGetVersion(void *arg)
@@ -227,7 +227,7 @@ static int platform_testGetVersion(void *arg)
}
/**
* \brief Tests SDL_VERSION macro
* Tests SDL_VERSION macro
*/
static int platform_testSDLVersion(void *arg)
{
@@ -249,7 +249,7 @@ static int platform_testSDLVersion(void *arg)
}
/**
* \brief Tests default SDL_Init
* Tests default SDL_Init
*/
static int platform_testDefaultInit(void *arg)
{
@@ -271,7 +271,7 @@ static int platform_testDefaultInit(void *arg)
}
/**
* \brief Tests SDL_Get/Set/ClearError
* Tests SDL_Get/Set/ClearError
* \sa SDL_GetError
* \sa SDL_SetError
* \sa SDL_ClearError
@@ -322,7 +322,7 @@ static int platform_testGetSetClearError(void *arg)
}
/**
* \brief Tests SDL_SetError with empty input
* Tests SDL_SetError with empty input
* \sa SDL_SetError
*/
static int platform_testSetErrorEmptyInput(void *arg)
@@ -363,7 +363,7 @@ static int platform_testSetErrorEmptyInput(void *arg)
#endif
/**
* \brief Tests SDL_SetError with invalid input
* Tests SDL_SetError with invalid input
* \sa SDL_SetError
*/
static int platform_testSetErrorInvalidInput(void *arg)
@@ -446,7 +446,7 @@ static int platform_testSetErrorInvalidInput(void *arg)
#endif
/**
* \brief Tests SDL_GetPowerInfo
* Tests SDL_GetPowerInfo
* \sa SDL_GetPowerInfo
*/
static int platform_testGetPowerInfo(void *arg)

6
test/testautomation_properties.c
View File

@@ -9,7 +9,7 @@
/* Test case functions */
/**
* \brief Test basic functionality
* Test basic functionality
*/
static int properties_testBasic(void *arg)
{
@@ -54,7 +54,7 @@ static int properties_testBasic(void *arg)
}
/**
* \brief Test cleanup functionality
* Test cleanup functionality
*/
static void SDLCALL cleanup(void *userdata, void *value)
{
@@ -91,7 +91,7 @@ static int properties_testCleanup(void *arg)
}
/**
* \brief Test locking functionality
* Test locking functionality
*/
struct properties_thread_data
{

78
test/testautomation_rect.c
View File

@@ -11,7 +11,7 @@
/* Helper functions */
/**
* \brief Private helper to check SDL_GetRectAndLineIntersection results
* Private helper to check SDL_GetRectAndLineIntersection results
*/
static void validateIntersectRectAndLineResults(
SDL_bool intersection, SDL_bool expectedIntersection,
@@ -38,7 +38,7 @@ static void validateIntersectRectAndLineResults(
/* Test case functions */
/**
* \brief Tests SDL_GetRectAndLineIntersection() clipping cases
* Tests SDL_GetRectAndLineIntersection() clipping cases
*
* \sa SDL_GetRectAndLineIntersection
*/
@@ -107,7 +107,7 @@ static int rect_testIntersectRectAndLine(void *arg)
}
/**
* \brief Tests SDL_GetRectAndLineIntersection() non-clipping case line inside
* Tests SDL_GetRectAndLineIntersection() non-clipping case line inside
*
* \sa SDL_GetRectAndLineIntersection
*/
@@ -172,7 +172,7 @@ static int rect_testIntersectRectAndLineInside(void *arg)
}
/**
* \brief Tests SDL_GetRectAndLineIntersection() non-clipping cases outside
* Tests SDL_GetRectAndLineIntersection() non-clipping cases outside
*
* \sa SDL_GetRectAndLineIntersection
*/
@@ -225,7 +225,7 @@ static int rect_testIntersectRectAndLineOutside(void *arg)
}
/**
* \brief Tests SDL_GetRectAndLineIntersection() with empty rectangle
* Tests SDL_GetRectAndLineIntersection() with empty rectangle
*
* \sa SDL_GetRectAndLineIntersection
*/
@@ -258,7 +258,7 @@ static int rect_testIntersectRectAndLineEmpty(void *arg)
}
/**
* \brief Negative tests against SDL_GetRectAndLineIntersection() with invalid parameters
* Negative tests against SDL_GetRectAndLineIntersection() with invalid parameters
*
* \sa SDL_GetRectAndLineIntersection
*/
@@ -291,7 +291,7 @@ static int rect_testIntersectRectAndLineParam(void *arg)
}
/**
* \brief Private helper to check SDL_HasRectIntersection results
* Private helper to check SDL_HasRectIntersection results
*/
static void validateHasIntersectionResults(
SDL_bool intersection, SDL_bool expectedIntersection,
@@ -314,7 +314,7 @@ static void validateHasIntersectionResults(
}
/**
* \brief Private helper to check SDL_GetRectIntersection results
* Private helper to check SDL_GetRectIntersection results
*/
static void validateIntersectRectResults(
SDL_bool intersection, SDL_bool expectedIntersection,
@@ -333,7 +333,7 @@ static void validateIntersectRectResults(
}
/**
* \brief Private helper to check SDL_GetRectUnion results
* Private helper to check SDL_GetRectUnion results
*/
static void validateUnionRectResults(
SDL_Rect *rectA, SDL_Rect *rectB, SDL_Rect *refRectA, SDL_Rect *refRectB,
@@ -356,7 +356,7 @@ static void validateUnionRectResults(
}
/**
* \brief Private helper to check SDL_RectEmpty results
* Private helper to check SDL_RectEmpty results
*/
static void validateRectEmptyResults(
SDL_bool empty, SDL_bool expectedEmpty,
@@ -374,7 +374,7 @@ static void validateRectEmptyResults(
}
/**
* \brief Private helper to check SDL_RectsEqual results
* Private helper to check SDL_RectsEqual results
*/
static void validateRectEqualsResults(
SDL_bool equals, SDL_bool expectedEquals,
@@ -397,7 +397,7 @@ static void validateRectEqualsResults(
}
/**
* \brief Private helper to check SDL_RectsEqualFloat results
* Private helper to check SDL_RectsEqualFloat results
*/
static void validateFRectEqualsResults(
SDL_bool equals, SDL_bool expectedEquals,
@@ -423,7 +423,7 @@ static void validateFRectEqualsResults(
}
/**
* \brief Tests SDL_GetRectIntersection() with B fully inside A
* Tests SDL_GetRectIntersection() with B fully inside A
*
* \sa SDL_GetRectIntersection
*/
@@ -450,7 +450,7 @@ static int rect_testIntersectRectInside(void *arg)
}
/**
* \brief Tests SDL_GetRectIntersection() with B fully outside A
* Tests SDL_GetRectIntersection() with B fully outside A
*
* \sa SDL_GetRectIntersection
*/
@@ -477,7 +477,7 @@ static int rect_testIntersectRectOutside(void *arg)
}
/**
* \brief Tests SDL_GetRectIntersection() with B partially intersecting A
* Tests SDL_GetRectIntersection() with B partially intersecting A
*
* \sa SDL_GetRectIntersection
*/
@@ -565,7 +565,7 @@ static int rect_testIntersectRectPartial(void *arg)
}
/**
* \brief Tests SDL_GetRectIntersection() with 1x1 pixel sized rectangles
* Tests SDL_GetRectIntersection() with 1x1 pixel sized rectangles
*
* \sa SDL_GetRectIntersection
*/
@@ -611,7 +611,7 @@ static int rect_testIntersectRectPoint(void *arg)
}
/**
* \brief Tests SDL_GetRectIntersection() with empty rectangles
* Tests SDL_GetRectIntersection() with empty rectangles
*
* \sa SDL_GetRectIntersection
*/
@@ -682,7 +682,7 @@ static int rect_testIntersectRectEmpty(void *arg)
}
/**
* \brief Negative tests against SDL_GetRectIntersection() with invalid parameters
* Negative tests against SDL_GetRectIntersection() with invalid parameters
*
* \sa SDL_GetRectIntersection
*/
@@ -711,7 +711,7 @@ static int rect_testIntersectRectParam(void *arg)
}
/**
* \brief Tests SDL_HasRectIntersection() with B fully inside A
* Tests SDL_HasRectIntersection() with B fully inside A
*
* \sa SDL_HasRectIntersection
*/
@@ -737,7 +737,7 @@ static int rect_testHasIntersectionInside(void *arg)
}
/**
* \brief Tests SDL_HasRectIntersection() with B fully outside A
* Tests SDL_HasRectIntersection() with B fully outside A
*
* \sa SDL_HasRectIntersection
*/
@@ -763,7 +763,7 @@ static int rect_testHasIntersectionOutside(void *arg)
}
/**
* \brief Tests SDL_HasRectIntersection() with B partially intersecting A
* Tests SDL_HasRectIntersection() with B partially intersecting A
*
* \sa SDL_HasRectIntersection
*/
@@ -829,7 +829,7 @@ static int rect_testHasIntersectionPartial(void *arg)
}
/**
* \brief Tests SDL_HasRectIntersection() with 1x1 pixel sized rectangles
* Tests SDL_HasRectIntersection() with 1x1 pixel sized rectangles
*
* \sa SDL_HasRectIntersection
*/
@@ -874,7 +874,7 @@ static int rect_testHasIntersectionPoint(void *arg)
}
/**
* \brief Tests SDL_HasRectIntersection() with empty rectangles
* Tests SDL_HasRectIntersection() with empty rectangles
*
* \sa SDL_HasRectIntersection
*/
@@ -931,7 +931,7 @@ static int rect_testHasIntersectionEmpty(void *arg)
}
/**
* \brief Negative tests against SDL_HasRectIntersection() with invalid parameters
* Negative tests against SDL_HasRectIntersection() with invalid parameters
*
* \sa SDL_HasRectIntersection
*/
@@ -953,7 +953,7 @@ static int rect_testHasIntersectionParam(void *arg)
}
/**
* \brief Test SDL_GetRectEnclosingPoints() without clipping
* Test SDL_GetRectEnclosingPoints() without clipping
*
* \sa SDL_GetRectEnclosingPoints
*/
@@ -1030,7 +1030,7 @@ static int rect_testEnclosePoints(void *arg)
}
/**
* \brief Test SDL_GetRectEnclosingPoints() with repeated input points
* Test SDL_GetRectEnclosingPoints() with repeated input points
*
* \sa SDL_GetRectEnclosingPoints
*/
@@ -1113,7 +1113,7 @@ static int rect_testEnclosePointsRepeatedInput(void *arg)
}
/**
* \brief Test SDL_GetRectEnclosingPoints() with clipping
* Test SDL_GetRectEnclosingPoints() with clipping
*
* \sa SDL_GetRectEnclosingPoints
*/
@@ -1219,7 +1219,7 @@ static int rect_testEnclosePointsWithClipping(void *arg)
}
/**
* \brief Negative tests against SDL_GetRectEnclosingPoints() with invalid parameters
* Negative tests against SDL_GetRectEnclosingPoints() with invalid parameters
*
* \sa SDL_GetRectEnclosingPoints
*/
@@ -1246,7 +1246,7 @@ static int rect_testEnclosePointsParam(void *arg)
}
/**
* \brief Tests SDL_GetRectUnion() where rect B is outside rect A
* Tests SDL_GetRectUnion() where rect B is outside rect A
*
* \sa SDL_GetRectUnion
*/
@@ -1324,7 +1324,7 @@ static int rect_testUnionRectOutside(void *arg)
}
/**
* \brief Tests SDL_GetRectUnion() where rect A or rect B are empty
* Tests SDL_GetRectUnion() where rect A or rect B are empty
*
* \sa SDL_GetRectUnion
*/
@@ -1388,7 +1388,7 @@ static int rect_testUnionRectEmpty(void *arg)
}
/**
* \brief Tests SDL_GetRectUnion() where rect B is inside rect A
* Tests SDL_GetRectUnion() where rect B is inside rect A
*
* \sa SDL_GetRectUnion
*/
@@ -1459,7 +1459,7 @@ static int rect_testUnionRectInside(void *arg)
}
/**
* \brief Negative tests against SDL_GetRectUnion() with invalid parameters
* Negative tests against SDL_GetRectUnion() with invalid parameters
*
* \sa SDL_GetRectUnion
*/
@@ -1486,7 +1486,7 @@ static int rect_testUnionRectParam(void *arg)
}
/**
* \brief Tests SDL_RectEmpty() with various inputs
* Tests SDL_RectEmpty() with various inputs
*
* \sa SDL_RectEmpty
*/
@@ -1528,7 +1528,7 @@ static int rect_testRectEmpty(void *arg)
}
/**
* \brief Negative tests against SDL_RectEmpty() with invalid parameters
* Negative tests against SDL_RectEmpty() with invalid parameters
*
* \sa SDL_RectEmpty
*/
@@ -1544,7 +1544,7 @@ static int rect_testRectEmptyParam(void *arg)
}
/**
* \brief Tests SDL_RectsEqual() with various inputs
* Tests SDL_RectsEqual() with various inputs
*
* \sa SDL_RectsEqual
*/
@@ -1573,7 +1573,7 @@ static int rect_testRectEquals(void *arg)
}
/**
* \brief Negative tests against SDL_RectsEqual() with invalid parameters
* Negative tests against SDL_RectsEqual() with invalid parameters
*
* \sa SDL_RectsEqual
*/
@@ -1605,7 +1605,7 @@ static int rect_testRectEqualsParam(void *arg)
}
/**
* \brief Tests SDL_RectsEqualFloat() with various inputs
* Tests SDL_RectsEqualFloat() with various inputs
*
* \sa SDL_RectsEqualFloat
*/
@@ -1634,7 +1634,7 @@ static int rect_testFRectEquals(void *arg)
}
/**
* \brief Negative tests against SDL_RectsEqualFloat() with invalid parameters
* Negative tests against SDL_RectsEqualFloat() with invalid parameters
*
* \sa SDL_RectsEqualFloat
*/
@@ -1804,7 +1804,7 @@ static const SDLTest_TestCaseReference rectTest31 = {
};
/**
* \brief Sequence of Rect test cases; functions that handle simple rectangles including overlaps and merges.
* Sequence of Rect test cases; functions that handle simple rectangles including overlaps and merges.
*/
static const SDLTest_TestCaseReference *rectTests[] = {
&rectTest1, &rectTest2, &rectTest3, &rectTest4, &rectTest5, &rectTest6, &rectTest7, &rectTest8, &rectTest9, &rectTest10, &rectTest11, &rectTest12, &rectTest13, &rectTest14,

36
test/testautomation_render.c
View File

@@ -90,7 +90,7 @@ static void CleanupDestroyRenderer(void *arg)
}
/**
* \brief Tests call to SDL_GetNumRenderDrivers
* Tests call to SDL_GetNumRenderDrivers
*
* \sa SDL_GetNumRenderDrivers
*/
@@ -103,7 +103,7 @@ static int render_testGetNumRenderDrivers(void *arg)
}
/**
* \brief Tests the SDL primitives for rendering.
* Tests the SDL primitives for rendering.
*
* \sa SDL_SetRenderDrawColor
* \sa SDL_RenderFillRect
@@ -190,7 +190,7 @@ static int render_testPrimitives(void *arg)
}
/**
* \brief Tests the SDL primitives with alpha for rendering.
* Tests the SDL primitives with alpha for rendering.
*
* \sa SDL_SetRenderDrawColor
* \sa SDL_SetRenderDrawBlendMode
@@ -333,7 +333,7 @@ static int render_testPrimitivesBlend(void *arg)
}
/**
* \brief Tests some blitting routines.
* Tests some blitting routines.
*
* \sa SDL_RenderTexture
* \sa SDL_DestroyTexture
@@ -400,7 +400,7 @@ static int render_testBlit(void *arg)
}
/**
* \brief Blits doing color tests.
* Blits doing color tests.
*
* \sa SDL_SetTextureColorMod
* \sa SDL_RenderTexture
@@ -474,7 +474,7 @@ static int render_testBlitColor(void *arg)
}
/**
* \brief Tests blitting with alpha.
* Tests blitting with alpha.
*
* \sa SDL_SetTextureAlphaMod
* \sa SDL_RenderTexture
@@ -551,7 +551,7 @@ static int render_testBlitAlpha(void *arg)
}
/**
* \brief Tests a blend mode.
* Tests a blend mode.
*
* \sa SDL_SetTextureBlendMode
* \sa SDL_RenderTexture
@@ -602,7 +602,7 @@ testBlitBlendMode(SDL_Texture *tface, int mode)
}
/**
* \brief Tests some more blitting routines.
* Tests some more blitting routines.
*
* \sa SDL_SetTextureColorMod
* \sa SDL_SetTextureAlphaMod
@@ -759,7 +759,7 @@ static int render_testBlitBlend(void *arg)
}
/**
* \brief Test viewport
* Test viewport
*/
static int render_testViewport(void *arg)
{
@@ -816,7 +816,7 @@ static int render_testViewport(void *arg)
}
/**
* \brief Test logical size
* Test logical size
*/
static int render_testLogicalSize(void *arg)
{
@@ -926,7 +926,7 @@ static int render_testLogicalSize(void *arg)
/* Helper functions */
/**
* \brief Checks to see if functionality is supported. Helper function.
* Checks to see if functionality is supported. Helper function.
*/
static int
isSupported(int code)
@@ -935,7 +935,7 @@ isSupported(int code)
}
/**
* \brief Test to see if we can vary the draw color. Helper function.
* Test to see if we can vary the draw color. Helper function.
*
* \sa SDL_SetRenderDrawColor
* \sa SDL_GetRenderDrawColor
@@ -976,7 +976,7 @@ hasDrawColor(void)
}
/**
* \brief Test to see if we can vary the blend mode. Helper function.
* Test to see if we can vary the blend mode. Helper function.
*
* \sa SDL_SetRenderDrawBlendMode
* \sa SDL_GetRenderDrawBlendMode
@@ -1043,7 +1043,7 @@ hasBlendModes(void)
}
/**
* \brief Loads the test image 'Face' as texture. Helper function.
* Loads the test image 'Face' as texture. Helper function.
*
* \sa SDL_CreateTextureFromSurface
*/
@@ -1069,7 +1069,7 @@ loadTestFace(void)
}
/**
* \brief Test to see if can set texture color mode. Helper function.
* Test to see if can set texture color mode. Helper function.
*
* \sa SDL_SetTextureColorMod
* \sa SDL_GetTextureColorMod
@@ -1112,7 +1112,7 @@ hasTexColor(void)
}
/**
* \brief Test to see if we can vary the alpha of the texture. Helper function.
* Test to see if we can vary the alpha of the texture. Helper function.
*
* \sa SDL_SetTextureAlphaMod
* \sa SDL_GetTextureAlphaMod
@@ -1155,7 +1155,7 @@ hasTexAlpha(void)
}
/**
* \brief Compares screen pixels with image pixels. Helper function.
* Compares screen pixels with image pixels. Helper function.
*
* \param referenceSurface Image to compare against.
* \param allowable_error allowed difference from the reference image
@@ -1200,7 +1200,7 @@ compare(SDL_Surface *referenceSurface, int allowable_error)
}
/**
* \brief Clears the screen. Helper function.
* Clears the screen. Helper function.
*
* \sa SDL_SetRenderDrawColor
* \sa SDL_RenderClear

16
test/testautomation_rwops.c
View File

@@ -90,7 +90,7 @@ static void RWopsTearDown(void *arg)
}
/**
* \brief Makes sure parameters work properly. Local helper function.
* Makes sure parameters work properly. Local helper function.
*
* \sa SDL_RWseek
* \sa SDL_RWread
@@ -245,7 +245,7 @@ static int rwops_testParamNegative(void *arg)
}
/**
* \brief Tests opening from memory.
* Tests opening from memory.
*
* \sa SDL_RWFromMem
* \sa SDL_RWClose
@@ -284,7 +284,7 @@ static int rwops_testMem(void *arg)
}
/**
* \brief Tests opening from memory.
* Tests opening from memory.
*
* \sa SDL_RWFromConstMem
* \sa SDL_RWClose
@@ -319,7 +319,7 @@ static int rwops_testConstMem(void *arg)
}
/**
* \brief Tests reading from file.
* Tests reading from file.
*
* \sa SDL_RWFromFile
* \sa SDL_RWClose
@@ -366,7 +366,7 @@ static int rwops_testFileRead(void *arg)
}
/**
* \brief Tests writing from file.
* Tests writing from file.
*
* \sa SDL_RWFromFile
* \sa SDL_RWClose
@@ -413,7 +413,7 @@ static int rwops_testFileWrite(void *arg)
}
/**
* \brief Tests alloc and free RW context.
* Tests alloc and free RW context.
*
* \sa SDL_CreateRW
* \sa SDL_DestroyRW
@@ -441,7 +441,7 @@ static int rwops_testAllocFree(void *arg)
}
/**
* \brief Compare memory and file reads
* Compare memory and file reads
*
* \sa SDL_RWFromMem
* \sa SDL_RWFromFile
@@ -504,7 +504,7 @@ static int rwops_testCompareRWFromMemWithRWFromFile(void *arg)
}
/**
* \brief Tests writing and reading from file using endian aware functions.
* Tests writing and reading from file using endian aware functions.
*
* \sa SDL_RWFromFile
* \sa SDL_RWClose

30
test/testautomation_sdltest.c
View File

@@ -12,7 +12,7 @@
/* Test case functions */
/**
* \brief Calls to SDLTest_GenerateRunSeed()
* Calls to SDLTest_GenerateRunSeed()
*/
static int sdltest_generateRunSeed(void *arg)
{
@@ -42,7 +42,7 @@ static int sdltest_generateRunSeed(void *arg)
}
/**
* \brief Calls to SDLTest_GetFuzzerInvocationCount()
* Calls to SDLTest_GetFuzzerInvocationCount()
*/
static int sdltest_getFuzzerInvocationCount(void *arg)
{
@@ -64,7 +64,7 @@ static int sdltest_getFuzzerInvocationCount(void *arg)
}
/**
* \brief Calls to random number generators
* Calls to random number generators
*/
static int sdltest_randomNumber(void *arg)
{
@@ -131,7 +131,7 @@ static int sdltest_randomNumber(void *arg)
}
/**
* \brief Calls to random boundary number generators for Uint8
* Calls to random boundary number generators for Uint8
*/
static int sdltest_randomBoundaryNumberUint8(void *arg)
{
@@ -240,7 +240,7 @@ static int sdltest_randomBoundaryNumberUint8(void *arg)
}
/**
* \brief Calls to random boundary number generators for Uint16
* Calls to random boundary number generators for Uint16
*/
static int sdltest_randomBoundaryNumberUint16(void *arg)
{
@@ -349,7 +349,7 @@ static int sdltest_randomBoundaryNumberUint16(void *arg)
}
/**
* \brief Calls to random boundary number generators for Uint32
* Calls to random boundary number generators for Uint32
*/
static int sdltest_randomBoundaryNumberUint32(void *arg)
{
@@ -458,7 +458,7 @@ static int sdltest_randomBoundaryNumberUint32(void *arg)
}
/**
* \brief Calls to random boundary number generators for Uint64
* Calls to random boundary number generators for Uint64
*/
static int sdltest_randomBoundaryNumberUint64(void *arg)
{
@@ -567,7 +567,7 @@ static int sdltest_randomBoundaryNumberUint64(void *arg)
}
/**
* \brief Calls to random boundary number generators for Sint8
* Calls to random boundary number generators for Sint8
*/
static int sdltest_randomBoundaryNumberSint8(void *arg)
{
@@ -676,7 +676,7 @@ static int sdltest_randomBoundaryNumberSint8(void *arg)
}
/**
* \brief Calls to random boundary number generators for Sint16
* Calls to random boundary number generators for Sint16
*/
static int sdltest_randomBoundaryNumberSint16(void *arg)
{
@@ -785,7 +785,7 @@ static int sdltest_randomBoundaryNumberSint16(void *arg)
}
/**
* \brief Calls to random boundary number generators for Sint32
* Calls to random boundary number generators for Sint32
*/
static int sdltest_randomBoundaryNumberSint32(void *arg)
{
@@ -901,7 +901,7 @@ static int sdltest_randomBoundaryNumberSint32(void *arg)
}
/**
* \brief Calls to random boundary number generators for Sint64
* Calls to random boundary number generators for Sint64
*/
static int sdltest_randomBoundaryNumberSint64(void *arg)
{
@@ -1010,7 +1010,7 @@ static int sdltest_randomBoundaryNumberSint64(void *arg)
}
/**
* \brief Calls to SDLTest_RandomIntegerInRange
* Calls to SDLTest_RandomIntegerInRange
*/
static int sdltest_randomIntegerInRange(void *arg)
{
@@ -1084,7 +1084,7 @@ static int sdltest_randomIntegerInRange(void *arg)
}
/**
* \brief Calls to SDLTest_RandomAsciiString
* Calls to SDLTest_RandomAsciiString
*/
static int sdltest_randomAsciiString(void *arg)
{
@@ -1116,7 +1116,7 @@ static int sdltest_randomAsciiString(void *arg)
}
/**
* \brief Calls to SDLTest_RandomAsciiStringWithMaximumLength
* Calls to SDLTest_RandomAsciiStringWithMaximumLength
*/
static int sdltest_randomAsciiStringWithMaximumLength(void *arg)
{
@@ -1168,7 +1168,7 @@ static int sdltest_randomAsciiStringWithMaximumLength(void *arg)
}
/**
* \brief Calls to SDLTest_RandomAsciiStringOfSize
* Calls to SDLTest_RandomAsciiStringOfSize
*/
static int sdltest_randomAsciiStringOfSize(void *arg)
{

14
test/testautomation_stdlib.c
View File

@@ -8,7 +8,7 @@
/* Test case functions */
/**
* \brief Call to SDL_strnlen
* Call to SDL_strnlen
*/
#undef SDL_strnlen
static int stdlib_strnlen(void *arg)
@@ -36,7 +36,7 @@ static int stdlib_strnlen(void *arg)
}
/**
* \brief Call to SDL_strlcpy
* Call to SDL_strlcpy
*/
#undef SDL_strlcpy
static int stdlib_strlcpy(void *arg)
@@ -71,7 +71,7 @@ static int stdlib_strlcpy(void *arg)
#endif
/**
* \brief Call to SDL_snprintf
* Call to SDL_snprintf
*/
#undef SDL_snprintf
static int stdlib_snprintf(void *arg)
@@ -262,7 +262,7 @@ static int stdlib_snprintf(void *arg)
}
/**
* \brief Call to SDL_swprintf
* Call to SDL_swprintf
*/
#undef SDL_swprintf
static int stdlib_swprintf(void *arg)
@@ -429,7 +429,7 @@ static int stdlib_swprintf(void *arg)
#endif
/**
* \brief Call to SDL_getenv and SDL_setenv
* Call to SDL_getenv and SDL_setenv
*/
static int stdlib_getsetenv(void *arg)
{
@@ -572,7 +572,7 @@ static int stdlib_getsetenv(void *arg)
#endif
/**
* \brief Call to SDL_sscanf
* Call to SDL_sscanf
*/
#undef SDL_sscanf
static int stdlib_sscanf(void *arg)
@@ -741,7 +741,7 @@ static int stdlib_sscanf(void *arg)
#endif
/**
* \brief Call to SDL_aligned_alloc
* Call to SDL_aligned_alloc
*/
static int stdlib_aligned_alloc(void *arg)
{

8
test/testautomation_subsystems.c
View File

@@ -34,7 +34,7 @@ static void subsystemsTearDown(void *arg)
/* Test case functions */
/**
* \brief Inits and Quits particular subsystem, checking its Init status.
* Inits and Quits particular subsystem, checking its Init status.
*
* \sa SDL_InitSubSystem
* \sa SDL_QuitSubSystem
@@ -83,7 +83,7 @@ static int subsystems_referenceCount()
}
/**
* \brief Inits and Quits subsystems that have another as dependency;
* Inits and Quits subsystems that have another as dependency;
* check that the dependency is not removed before the last of its dependents.
*
* \sa SDL_InitSubSystem
@@ -121,7 +121,7 @@ static int subsystems_dependRefCountInitAllQuitByOne()
}
/**
* \brief Inits and Quits subsystems that have another as dependency;
* Inits and Quits subsystems that have another as dependency;
* check that the dependency is not removed before the last of its dependents.
*
* \sa SDL_InitSubSystem
@@ -155,7 +155,7 @@ static int subsystems_dependRefCountInitByOneQuitAll()
}
/**
* \brief Inits and Quits subsystems that have another as dependency,
* Inits and Quits subsystems that have another as dependency,
* but also inits that dependency explicitly, giving it extra ref count.
* Check that the dependency is not removed before the last reference is gone.
*

20
test/testautomation_surface.c
View File

@@ -209,7 +209,7 @@ static void AssertFileExist(const char *filename)
/* Test case functions */
/**
* \brief Tests sprite saving and loading
* Tests sprite saving and loading
*/
static int surface_testSaveLoadBitmap(void *arg)
{
@@ -389,7 +389,7 @@ static int surface_testCompleteSurfaceConversion(void *arg)
}
/**
* \brief Tests sprite loading. A failure case.
* Tests sprite loading. A failure case.
*/
static int surface_testLoadFailure(void *arg)
{
@@ -400,7 +400,7 @@ static int surface_testLoadFailure(void *arg)
}
/**
* \brief Tests some blitting routines.
* Tests some blitting routines.
*/
static int surface_testBlit(void *arg)
{
@@ -422,7 +422,7 @@ static int surface_testBlit(void *arg)
}
/**
* \brief Tests some blitting routines with color mod
* Tests some blitting routines with color mod
*/
static int surface_testBlitColorMod(void *arg)
{
@@ -444,7 +444,7 @@ static int surface_testBlitColorMod(void *arg)
}
/**
* \brief Tests some blitting routines with alpha mod
* Tests some blitting routines with alpha mod
*/
static int surface_testBlitAlphaMod(void *arg)
{
@@ -466,7 +466,7 @@ static int surface_testBlitAlphaMod(void *arg)
}
/**
* \brief Tests some more blitting routines.
* Tests some more blitting routines.
*/
static int surface_testBlitBlendNone(void *arg)
{
@@ -488,7 +488,7 @@ static int surface_testBlitBlendNone(void *arg)
}
/**
* \brief Tests some more blitting routines.
* Tests some more blitting routines.
*/
static int surface_testBlitBlendBlend(void *arg)
{
@@ -510,7 +510,7 @@ static int surface_testBlitBlendBlend(void *arg)
}
/**
* \brief Tests some more blitting routines.
* Tests some more blitting routines.
*/
static int surface_testBlitBlendAdd(void *arg)
{
@@ -532,7 +532,7 @@ static int surface_testBlitBlendAdd(void *arg)
}
/**
* \brief Tests some more blitting routines.
* Tests some more blitting routines.
*/
static int surface_testBlitBlendMod(void *arg)
{
@@ -554,7 +554,7 @@ static int surface_testBlitBlendMod(void *arg)
}
/**
* \brief Tests some more blitting routines with loop
* Tests some more blitting routines with loop
*/
static int surface_testBlitBlendLoop(void *arg)
{

2
test/testautomation_syswm.c
View File

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

8
test/testautomation_timer.c
View File

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

36
test/testautomation_video.c
View File

@@ -73,7 +73,7 @@ static void destroyVideoSuiteTestWindow(SDL_Window *window)
/* Test case functions */
/**
* \brief Enable and disable screensaver while checking state
* Enable and disable screensaver while checking state
*/
static int video_enableDisableScreensaver(void *arg)
{
@@ -124,7 +124,7 @@ static int video_enableDisableScreensaver(void *arg)
}
/**
* \brief Tests the functionality of the SDL_CreateWindow function using different sizes
* Tests the functionality of the SDL_CreateWindow function using different sizes
*/
static int video_createWindowVariousSizes(void *arg)
{
@@ -178,7 +178,7 @@ static int video_createWindowVariousSizes(void *arg)
}
/**
* \brief Tests the functionality of the SDL_CreateWindow function using different flags
* Tests the functionality of the SDL_CreateWindow function using different flags
*/
static int video_createWindowVariousFlags(void *arg)
{
@@ -252,7 +252,7 @@ static int video_createWindowVariousFlags(void *arg)
}
/**
* \brief Tests the functionality of the SDL_GetWindowFlags function
* Tests the functionality of the SDL_GetWindowFlags function
*/
static int video_getWindowFlags(void *arg)
{
@@ -279,7 +279,7 @@ static int video_getWindowFlags(void *arg)
}
/**
* \brief Tests the functionality of the SDL_GetFullscreenDisplayModes function
* Tests the functionality of the SDL_GetFullscreenDisplayModes function
*/
static int video_getFullscreenDisplayModes(void *arg)
{
@@ -308,7 +308,7 @@ static int video_getFullscreenDisplayModes(void *arg)
}
/**
* \brief Tests the functionality of the SDL_GetClosestFullscreenDisplayMode function against current resolution
* Tests the functionality of the SDL_GetClosestFullscreenDisplayMode function against current resolution
*/
static int video_getClosestDisplayModeCurrentResolution(void *arg)
{
@@ -358,7 +358,7 @@ static int video_getClosestDisplayModeCurrentResolution(void *arg)
}
/**
* \brief Tests the functionality of the SDL_GetClosestFullscreenDisplayMode function against random resolution
* Tests the functionality of the SDL_GetClosestFullscreenDisplayMode function against random resolution
*/
static int video_getClosestDisplayModeRandomResolution(void *arg)
{
@@ -396,7 +396,7 @@ static int video_getClosestDisplayModeRandomResolution(void *arg)
}
/**
* \brief Tests call to SDL_GetWindowFullscreenMode
* Tests call to SDL_GetWindowFullscreenMode
*
* \sa SDL_GetWindowFullscreenMode
*/
@@ -440,7 +440,7 @@ static void checkInvalidWindowError(void)
}
/**
* \brief Tests call to SDL_GetWindowFullscreenMode with invalid input
* Tests call to SDL_GetWindowFullscreenMode with invalid input
*
* \sa SDL_GetWindowFullscreenMode
*/
@@ -528,7 +528,7 @@ static void setAndCheckWindowKeyboardGrabState(SDL_Window *window, SDL_bool desi
}
/**
* \brief Tests keyboard and mouse grab support
* Tests keyboard and mouse grab support
*
* \sa SDL_GetWindowGrab
* \sa SDL_SetWindowGrab
@@ -689,7 +689,7 @@ static int video_getSetWindowGrab(void *arg)
}
/**
* \brief Tests call to SDL_GetWindowID and SDL_GetWindowFromID
* Tests call to SDL_GetWindowID and SDL_GetWindowFromID
*
* \sa SDL_GetWindowID
* \sa SDL_SetWindowFromID
@@ -746,7 +746,7 @@ static int video_getWindowId(void *arg)
}
/**
* \brief Tests call to SDL_GetWindowPixelFormat
* Tests call to SDL_GetWindowPixelFormat
*
* \sa SDL_GetWindowPixelFormat
*/
@@ -812,7 +812,7 @@ static SDL_bool getSizeFromEvent(int *w, int *h)
}
/**
* \brief Tests call to SDL_GetWindowPosition and SDL_SetWindowPosition
* Tests call to SDL_GetWindowPosition and SDL_SetWindowPosition
*
* \sa SDL_GetWindowPosition
* \sa SDL_SetWindowPosition
@@ -973,7 +973,7 @@ static void checkInvalidParameterError(void)
}
/**
* \brief Tests call to SDL_GetWindowSize and SDL_SetWindowSize
* Tests call to SDL_GetWindowSize and SDL_SetWindowSize
*
* \sa SDL_GetWindowSize
* \sa SDL_SetWindowSize
@@ -1158,7 +1158,7 @@ static int video_getSetWindowSize(void *arg)
}
/**
* \brief Tests call to SDL_GetWindowMinimumSize and SDL_SetWindowMinimumSize
* Tests call to SDL_GetWindowMinimumSize and SDL_SetWindowMinimumSize
*
*/
static int video_getSetWindowMinimumSize(void *arg)
@@ -1301,7 +1301,7 @@ static int video_getSetWindowMinimumSize(void *arg)
}
/**
* \brief Tests call to SDL_GetWindowMaximumSize and SDL_SetWindowMaximumSize
* Tests call to SDL_GetWindowMaximumSize and SDL_SetWindowMaximumSize
*
*/
static int video_getSetWindowMaximumSize(void *arg)
@@ -1439,7 +1439,7 @@ static int video_getSetWindowMaximumSize(void *arg)
}
/**
* \brief Tests call to SDL_SetWindowData and SDL_GetWindowData
* Tests call to SDL_SetWindowData and SDL_GetWindowData
*
* \sa SDL_SetWindowData
* \sa SDL_GetWindowData
@@ -1629,7 +1629,7 @@ cleanup:
}
/**
* \brief Tests the functionality of the SDL_WINDOWPOS_CENTERED_DISPLAY along with SDL_WINDOW_FULLSCREEN.
* Tests the functionality of the SDL_WINDOWPOS_CENTERED_DISPLAY along with SDL_WINDOW_FULLSCREEN.
*
* Especially 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.

2
test/testhaptic.c
View File

@@ -27,7 +27,7 @@ static void abort_execution(void);
static void HapticPrintSupported(SDL_Haptic *);
/**
* \brief The entry point of this force feedback demo.
* The entry point of this force feedback demo.
* \param[in] argc Number of arguments.
* \param[in] argv Array of argc arguments.
*/

2
test/testrumble.c
View File

@@ -29,7 +29,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
static SDL_Haptic *haptic;
/**
* \brief The entry point of this force feedback demo.
* The entry point of this force feedback demo.
* \param[in] argc Number of arguments.
* \param[in] argv Array of argc arguments.
*/