Updated documentation for functions that return temporary memory

2024-07-19 10:54:27 -07:00
parent 68322ac851
commit 71a60d4c0e
24 changed files with 85 additions and 146 deletions
--- a/include/SDL3/SDL_guid.h
+++ b/include/SDL3/SDL_guid.h
@@ -66,7 +66,7 @@ typedef struct SDL_GUID {
 /**
 * Get an ASCII string representation for a given SDL_GUID.
 *
- * The returned string follows the SDL_GetStringRule, and will be automatically freed later.
+ * This returns temporary memory which will be automatically freed later, and can be claimed with SDL_ClaimTemporaryMemory().
 *
 * \param guid the SDL_GUID you wish to convert to string.
 * \returns the string representation of the GUID or NULL on failure; call