eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-16 01:38:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

SDL_assert.h: Documentation improvements.

Browse source
This commit is contained in:
Ryan C. Gordon 2024-04-24 15:06:23 -04:00
parent e56f05bac1
commit ec97857a87
No known key found for this signature in database
GPG key ID: FA148B892AB48044
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
include/SDL3/SDL_assert.h
View file

@ -68,7 +68,7 @@ extern "C" {
* *
* \since This macro is available since SDL 3.0.0. * \since This macro is available since SDL 3.0.0.
*/ */
#define SDL_TriggerBreakpoint() __asm__ __volatile__ ( "int $3\n\t" ) #define SDL_TriggerBreakpoint() TriggerABreakpointInAPlatformSpecificManner
#elif defined(_MSC_VER) #elif defined(_MSC_VER)
/* Don't include intrin.h here because it contains C++ code */ /* Don't include intrin.h here because it contains C++ code */
@ -166,19 +166,19 @@ typedef enum SDL_AssertState
*/ */
typedef struct SDL_AssertData typedef struct SDL_AssertData
{ {
SDL_bool always_ignore; SDL_bool always_ignore; /**< SDL_TRUE if app should always continue when assertion is triggered. */
unsigned int trigger_count; unsigned int trigger_count; /**< Number of times this assertion has been triggered. */
const char *condition; const char *condition; /**< A string of this assert's test code. */
const char *filename; const char *filename; /**< The source file where this assert lives. */
int linenum; int linenum; /**< The line in `filename` where this assert lives. */
const char *function; const char *function; /**< The name of the function where this assert lives. */
const struct SDL_AssertData *next; const struct SDL_AssertData *next; /**< next item in the linked list. */
} SDL_AssertData; } SDL_AssertData;
/** /**
* Never call this directly. * Never call this directly.
* *
* Use the SDL_assert* macros. * Use the SDL_assert* macros instead.
* *
* \param data assert data structure * \param data assert data structure
* \param func function name * \param func function name