Clarify that the SDL_GetStringRule means that SDL will automatically free the memory later.

2024-07-17 23:20:23 -07:00
parent 0d24b6e9f3
commit d73c7311d5
23 changed files with 66 additions and 69 deletions
--- a/include/SDL3/SDL_pen.h
+++ b/include/SDL3/SDL_pen.h
@@ -224,7 +224,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_PenConnected(SDL_PenID instance_id);
 /**
 * Retrieves a human-readable description for a SDL_PenID.
 *
- * The returned string follows the SDL_GetStringRule.
+ * The returned string follows the SDL_GetStringRule, and will be automatically freed later.
 *
 * \param instance_id the pen to query.
 * \returns a string that contains the name of the pen, intended for human