mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-30 15:08:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

hashtable: Fix documentation typos

Browse Source
This commit is contained in:
Frank Praznik
2025-07-09 12:38:16 -04:00
parent c64518f300
commit 11ec0c7a8f
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/SDL_hashtable.h
View File

@@ -219,10 +219,10 @@ typedef void (SDLCALL *SDL_HashDestroyCallback)(void *userdata, const void *key,
* \returns true to keep iterating, false to stop iteration. * \returns true to keep iterating, false to stop iteration.
* *
* \threadsafety A read lock is held during iteration, so other threads can * \threadsafety A read lock is held during iteration, so other threads can
* still access the the hash table, but threads attempting to * still access the hash table, but threads attempting to make
* make changes will be blocked until iteration completes. If * changes will be blocked until iteration completes. If this
* this is a concern, do as little in the callback as possible * is a concern, do as little in the callback as possible and
* and finish iteration quickly. * finish iteration quickly.
* *
* \since This datatype is available since SDL 3.4.0. * \since This datatype is available since SDL 3.4.0.
* *
@@ -248,7 +248,7 @@ typedef bool (SDLCALL *SDL_HashTableIterateCallback)(void *userdata, const SDL_H
* *
* You can specify an estimate of the number of items expected to be stored * You can specify an estimate of the number of items expected to be stored
* in the table, which can help make the table run more efficiently. The table * in the table, which can help make the table run more efficiently. The table
* will preallocate resources to accomodate this number of items, which is * will preallocate resources to accommodate this number of items, which is
* most useful if you intend to fill the table with a lot of data right after * most useful if you intend to fill the table with a lot of data right after
* creating it. Otherwise, it might make more sense to specify the _minimum_ * creating it. Otherwise, it might make more sense to specify the _minimum_
* you expect the table to hold and let it grow as necessary from there. This * you expect the table to hold and let it grow as necessary from there. This
@@ -422,7 +422,7 @@ extern bool SDL_HashTableEmpty(SDL_HashTable *table);
* \param table the hash table to iterate. * \param table the hash table to iterate.
* \param callback the function pointer to call for each value. * \param callback the function pointer to call for each value.
* \param userdata a pointer that is passed to `callback`. * \param userdata a pointer that is passed to `callback`.
* \returns true if iteration happened, false if not (bogus parameter, etc). * \returns true if iteration happened, false if not (bogus parameter, etc.).
* *
* \since This function is available since SDL 3.4.0. * \since This function is available since SDL 3.4.0.
*/ */