Procházet zdrojové kódy

locale: Added docs to SDL_Locale struct, to fix wiki docs.

Ryan C. Gordon před 17 hodinami
rodič
revize
56846df9b0
1 změnil soubory, kde provedl 13 přidání a 1 odebrání
  1. 13 1
      include/SDL_locale.h

+ 13 - 1
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.
  *