mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-17 15:21:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

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
80 changed files with 6963 additions and 6115 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/SDL_test_harness.h
View File

@@ -19,7 +19,7 @@
3. This notice may not be removed or altered from any source distribution.
*/
/**
/*
* \file SDL_test_harness.h
*
* Include file for SDL test framework.
@@ -69,7 +69,7 @@ typedef int (*SDLTest_TestCaseFp)(void *arg);
/* !< Function pointer to a test case teardown function (run after every test) */
typedef void (*SDLTest_TestCaseTearDownFp)(void *arg);
/**
/*
* Holds information about a single test case.
*/
typedef struct SDLTest_TestCaseReference {
@@ -83,7 +83,7 @@ typedef struct SDLTest_TestCaseReference {
int enabled;
} SDLTest_TestCaseReference;
/**
/*
* Holds information about a test suite (multiple test cases).
*/
typedef struct SDLTest_TestSuiteReference {
@@ -98,7 +98,7 @@ typedef struct SDLTest_TestSuiteReference {
} SDLTest_TestSuiteReference;
/**
/*
* \brief Generates a random run seed string for the harness. The generated seed will contain alphanumeric characters (0-9A-Z).
*
* Note: The returned string needs to be deallocated by the caller.
@@ -109,7 +109,7 @@ typedef struct SDLTest_TestSuiteReference {
*/
char *SDLTest_GenerateRunSeed(const int length);
/**
/*
* \brief Execute a test suite using the given run seed and execution key.
*
* \param testSuites Suites containing the test case.