Browse Source

Documented the return value of SDL_GetDateTimeLocalePreferences()

Sam Lantinga 1 year ago
parent
commit
06a5d4d24f
1 changed files with 2 additions and 0 deletions
  1. 2 0
      include/SDL3/SDL_time.h

+ 2 - 0
include/SDL3/SDL_time.h

@@ -95,6 +95,8 @@ typedef enum SDL_TimeFormat
  *                   format, may be NULL
  *                   format, may be NULL
  * \param timeFormat a pointer to the SDL_TimeFormat to hold the returned time
  * \param timeFormat a pointer to the SDL_TimeFormat to hold the returned time
  *                   format, may be NULL
  *                   format, may be NULL
+ * \returns 0 on success or -1 on error; call SDL_GetError() for more
+ *          information.
  *
  *
  * \since This function is available since SDL 3.0.0.
  * \since This function is available since SDL 3.0.0.
  */
  */