include: Clarified documentation for two functions.

main
Ryan C. Gordon 2023-11-29 15:56:26 -05:00
parent daa38dc793
commit d1b831e232
2 changed files with 5 additions and 2 deletions

View File

@ -314,7 +314,10 @@ extern DECLSPEC int SDLCALL SDL_ReloadGamepadMappings(void);
/**
* Get the mapping at a particular index.
*
* \param count On return, set to the number of mappings returned. Can be NULL.
* You must free the returned pointer with SDL_free() when you are done with
* it, but you do _not_ free each string in the array.
*
* \param count a pointer filled in with the number of mappings returned, can be NULL.
* \returns an array of the mapping strings, NULL-terminated. Must be freed with SDL_free().
* Returns NULL on error.
*

View File

@ -74,7 +74,7 @@ typedef struct SDL_Finger
*
* This was fixed for Android in SDL 2.0.1.
*
* \param count a pointer filled in with the number of devices returned
* \param count a pointer filled in with the number of devices returned, can be NULL.
* \returns a 0 terminated array of touch device IDs which should be
* freed with SDL_free(), or NULL on error; call SDL_GetError() for
* more details.