eden-emu/SDL
20
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: heavy editing to make this happy with latest wikibridge.

Browse source 
The public headers saw lots of cleanups, backporting from SDL3 docs, and
merging with the wiki.

The markdown files in docs/README-*.md were converted to Unix endlines.
This commit is contained in:
Ryan C. Gordon 2024-04-23 14:19:47 -04:00
parent a96196c958
commit e03ad30a57
No known key found for this signature in database
GPG key ID: FA148B892AB48044
80 changed files with 6963 additions and 6115 deletions
Download patch file Download diff file Expand all files Collapse all files

18
include/SDL_test_assert.h
View file

@ -19,7 +19,7 @@
3. This notice may not be removed or altered from any source distribution.
*/
/**
/*
* \file SDL_test_assert.h
*
* Include file for SDL test framework.
@ -42,17 +42,17 @@
extern "C" {
#endif
/**
/*
* \brief Fails the assert.
*/
#define ASSERT_FAIL 0
/**
/*
* \brief Passes the assert.
*/
#define ASSERT_PASS 1
/**
/*
* \brief Assert that logs and break execution flow on failures.
*
* \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
@ -60,7 +60,7 @@ extern "C" {
*/
void SDLTest_Assert(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2);
/**
/*
* \brief Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters.
*
* \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
@ -70,25 +70,25 @@ void SDLTest_Assert(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *as
*/
int SDLTest_AssertCheck(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2);
/**
/*
* \brief Explicitly pass without checking an assertion condition. Updates assertion counter.
*
* \param assertDescription Message to log with the assert describing it.
*/
void SDLTest_AssertPass(SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(1);
/**
/*
* \brief Resets the assert summary counters to zero.
*/
void SDLTest_ResetAssertSummary(void);
/**
/*
* \brief Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR.
*/
void SDLTest_LogAssertSummary(void);
/**
/*
* \brief Converts the current assert summary state to a test result.
*
* \returns TEST_RESULT_PASSED, TEST_RESULT_FAILED, or TEST_RESULT_NO_ASSERT