From e290d16c47fed58467758051e74bd2c4bb24013c Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Tue, 2 Jul 2024 12:29:33 -0400 Subject: [PATCH] include: Clean up SDL_GetKeyName documentation. --- include/SDL3/SDL_keyboard.h | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/include/SDL3/SDL_keyboard.h b/include/SDL3/SDL_keyboard.h index 0ae88b8f88..67f3cbb7bd 100644 --- a/include/SDL3/SDL_keyboard.h +++ b/include/SDL3/SDL_keyboard.h @@ -324,13 +324,12 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromName(const char *nam * Both lowercase and uppercase alphabetic keycodes have uppercase names, e.g. * SDL_Keycode 'a' and 'A' both have the name "A". * + * If the key doesn't have a name, this function returns an empty string (""). + * * The returned string follows the SDL_GetStringRule. * * \param key the desired SDL_Keycode to query. - * \returns a pointer to a UTF-8 string that stays valid at least until the - * next call to this function. If you need it around any longer, you - * must copy it. If the key doesn't have a name, this function - * returns an empty string (""). + * \returns a UTF-8 encoded string of the key name. * * \since This function is available since SDL 3.0.0. *