From 56846df9b02e544e62d274954897044d08cc627e Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Mon, 22 Jun 2026 22:09:23 -0400 Subject: [PATCH] locale: Added docs to SDL_Locale struct, to fix wiki docs. --- include/SDL_locale.h | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/include/SDL_locale.h b/include/SDL_locale.h index 6638cb3add..2df7a6d663 100644 --- a/include/SDL_locale.h +++ b/include/SDL_locale.h @@ -39,13 +39,25 @@ extern "C" { /* *INDENT-ON* */ #endif - +/** + * A struct to provide locale data. + * + * Locale data is split into a spoken language, like English, and an optional + * country, like Canada. The language will be in ISO-639 format (so English + * would be "en"), and the country, if not NULL, will be an ISO-3166 country + * code (so Canada would be "CA"). + * + * \since This function is available since SDL 3.2.0. + * + * \sa SDL_GetPreferredLocales + */ typedef struct SDL_Locale { const char *language; /**< A language name, like "en" for English. */ const char *country; /**< A country, like "US" for America. Can be NULL. */ } SDL_Locale; + /** * Report the user's preferred locale. *