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

4
src/test/SDL_test_assert.c
View File

@@ -48,10 +48,10 @@
#define SDLTEST_ASSERT_SUMMARY_FORMAT "Assert Summary: Total=%d " COLOR_GREEN "Passed=%d" COLOR_END " " COLOR_RED "Failed=%d" COLOR_END
#define SDLTEST_ASSERT_SUMMARY_FORMAT_OK "Assert Summary: Total=%d " COLOR_GREEN "Passed=%d" COLOR_END " " COLOR_GREEN "Failed=%d" COLOR_END
/* ! \brief counts the failed asserts */
/* ! counts the failed asserts */
static int SDLTest_AssertsFailed = 0;
/* ! \brief counts the passed asserts */
/* ! counts the passed asserts */
static int SDLTest_AssertsPassed = 0;
/*

2
src/test/SDL_test_font.c
View File

@@ -3122,7 +3122,7 @@ struct SDLTest_CharTextureCache
};
/*!
\brief List of per-renderer caches for 8x8 pixel font textures created at runtime.
List of per-renderer caches for 8x8 pixel font textures created at runtime.
*/
static struct SDLTest_CharTextureCache *SDLTest_CharTextureCacheList;

10
src/test/SDL_test_harness.c
View File

@@ -47,7 +47,7 @@
/* Final result message format */
#define SDLTEST_FINAL_RESULT_FORMAT COLOR_YELLOW ">>> %s '%s':" COLOR_END " %s\n"
/* ! \brief Timeout for single test case execution */
/* ! Timeout for single test case execution */
static Uint32 SDLTest_TestCaseTimeout = 3600;
/**
@@ -167,7 +167,7 @@ static Uint64 SDLTest_GenerateExecKey(const char *runSeed, const char *suiteName
}
/**
* \brief Set timeout handler for test.
* Set timeout handler for test.
*
* Note: SDL_Init(SDL_INIT_TIMER) will be called if it wasn't done so before.
*
@@ -211,7 +211,7 @@ static SDL_TimerID SDLTest_SetTestTimeout(int timeout, void(SDLCALL *callback)(v
}
/**
* \brief Timeout handler. Aborts test run and exits harness process.
* Timeout handler. Aborts test run and exits harness process.
*/
#ifdef __WATCOMC__
#pragma aux SDLTest_BailOut aborts;
@@ -223,7 +223,7 @@ static SDL_NORETURN void SDLCALL SDLTest_BailOut(void)
}
/**
* \brief Execute a test using the given execution key.
* Execute a test using the given execution key.
*
* \param testSuite Suite containing the test case.
* \param testCase Case to execute.
@@ -356,7 +356,7 @@ static float GetClock(void)
}
/**
* \brief Execute a test suite using the given run seed and execution key.
* Execute a test suite using the given run seed and execution key.
*
* The filter string is matched to the suite name (full comparison) to select a single suite,
* or if no suite matches, it is matched to the test names (full comparison) to select a single test.