Pārlūkot izejas kodu

Progress bar comment changes

Petar Popovic 3 nedēļas atpakaļ
vecāks
revīzija
00f316737b
1 mainītis faili ar 3 papildinājumiem un 3 dzēšanām
  1. 3 3
      include/SDL3/SDL_video.h

+ 3 - 3
include/SDL3/SDL_video.h

@@ -2840,7 +2840,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressState(SDL_Window *window,
  * Get the state of the progress bar for the given window’s taskbar icon.
  *
  * \param window the window to get the current progress state from.
- * \returns the progress state, or SDL_PROGRESS_STATE_INVALID on failure; call
+ * \returns the progress state, or `SDL_PROGRESS_STATE_INVALID` on failure; call
  *          SDL_GetError() for more information.
  *
  * \threadsafety This function should only be called on the main thread.
@@ -2853,7 +2853,7 @@ extern SDL_DECLSPEC SDL_ProgressState SDLCALL SDL_GetWindowProgressState(SDL_Win
  * Sets the value of the progress bar for the given window’s taskbar icon.
  *
  * \param window the window whose progress value is to be modified.
- * \param value the progress value (0.0f - start, 1.0f - end). If the value is
+ * \param value the progress value in the range of [0.0f - 1.0f]. If the value is
  *              outside the valid range, it gets clamped.
  * \returns true on success or false on failure; call SDL_GetError() for more
  *          information.
@@ -2868,7 +2868,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowProgressValue(SDL_Window *window,
  * Get the value of the progress bar for the given window’s taskbar icon.
  *
  * \param window the window to get the current progress value from.
- * \returns the progress value in the range of [0.0 - 1.0], or -1 on failure;
+ * \returns the progress value in the range of [0.0f - 1.0f], or -1.0f on failure;
  *          call SDL_GetError() for more information.
  *
  * \threadsafety This function should only be called on the main thread.