docs: Add \threadsafety to some low-hanging fruit across a few headers.

Reference Issue #7140.
This commit is contained in:
Ryan C. Gordon
2024-10-22 13:47:28 -04:00
parent eed11ad6d6
commit 2318961b6f
4 changed files with 70 additions and 0 deletions

View File

@@ -1261,6 +1261,8 @@ typedef int (SDLCALL *SDL_CompareCallback)(const void *a, const void *b);
* \param size the size of the elements in the array.
* \param compare a function used to compare elements in the array.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_bsearch
@@ -1309,6 +1311,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size
* \returns a pointer to the matching element in the array, or NULL if not
* found.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_bsearch_r
@@ -1377,6 +1381,8 @@ typedef int (SDLCALL *SDL_CompareCallback_r)(void *userdata, const void *a, cons
* \param compare a function used to compare elements in the array.
* \param userdata a pointer to pass to the compare function.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_bsearch_r
@@ -1433,6 +1439,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_qsort_r(void *base, size_t nmemb, size_t si
* \returns a pointer to the matching element in the array, or NULL if not
* found.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_bsearch