From 18c8af6e4885ceb28c57eafc0dbc4310a93c52b4 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Mon, 1 Apr 2024 21:00:26 +0000 Subject: [PATCH] Sync SDL3 wiki -> header --- include/SDL3/SDL_gamepad.h | 9 +++++++-- include/SDL3/SDL_joystick.h | 12 +++++++++--- include/SDL3/SDL_power.h | 12 +++++++++--- 3 files changed, 25 insertions(+), 8 deletions(-) diff --git a/include/SDL3/SDL_gamepad.h b/include/SDL3/SDL_gamepad.h index 71ae15805..9d2e86eaa 100644 --- a/include/SDL3/SDL_gamepad.h +++ b/include/SDL3/SDL_gamepad.h @@ -845,7 +845,9 @@ extern DECLSPEC Uint64 SDLCALL SDL_GetGamepadSteamHandle(SDL_Gamepad *gamepad); * Get the connection state of a gamepad. * * \param gamepad the gamepad object to query. - * \returns the connection state on success or `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError() for more information. + * \returns the connection state on success or + * `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -861,7 +863,10 @@ extern DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetGamepadConnectionStat * reports, or completely drain when reporting it has 20 percent left, etc. * * \param gamepad the gamepad object to query. - * \param percent a pointer filled in with the percentage of battery life left, between 0 and 100, or NULL to ignore. This will be filled in with -1 we can't determine a value or there is no battery. + * \param percent a pointer filled in with the percentage of battery life + * left, between 0 and 100, or NULL to ignore. This will be + * filled in with -1 we can't determine a value or there is no + * battery. * \returns the current battery state. * * \since This function is available since SDL 3.0.0. diff --git a/include/SDL3/SDL_joystick.h b/include/SDL3/SDL_joystick.h index 5c7ac5b05..3840c9afc 100644 --- a/include/SDL3/SDL_joystick.h +++ b/include/SDL3/SDL_joystick.h @@ -1083,7 +1083,9 @@ extern DECLSPEC void SDLCALL SDL_CloseJoystick(SDL_Joystick *joystick); * Get the connection state of a joystick. * * \param joystick The joystick to query - * \returns the connection state on success or `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError() for more information. + * \returns the connection state on success or + * `SDL_JOYSTICK_CONNECTION_INVALID` on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1099,8 +1101,12 @@ extern DECLSPEC SDL_JoystickConnectionState SDLCALL SDL_GetJoystickConnectionSta * reports, or completely drain when reporting it has 20 percent left, etc. * * \param joystick The joystick to query - * \param percent a pointer filled in with the percentage of battery life left, between 0 and 100, or NULL to ignore. This will be filled in with -1 we can't determine a value or there is no battery. - * \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure; call SDL_GetError() for more information. + * \param percent a pointer filled in with the percentage of battery life + * left, between 0 and 100, or NULL to ignore. This will be + * filled in with -1 we can't determine a value or there is no + * battery. + * \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure; + * call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_power.h b/include/SDL3/SDL_power.h index a37bdee2a..117fc0fc1 100644 --- a/include/SDL3/SDL_power.h +++ b/include/SDL3/SDL_power.h @@ -65,9 +65,15 @@ typedef enum * It's possible a platform can only report battery percentage or time left * but not both. * - * \param seconds a pointer filled in with the seconds of battery life left, or NULL to ignore. This will be filled in with -1 if we can't determine a value or there is no battery. - * \param percent a pointer filled in with the percentage of battery life left, between 0 and 100, or NULL to ignore. This will be filled in with -1 we can't determine a value or there is no battery. - * \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure; call SDL_GetError() for more information. + * \param seconds a pointer filled in with the seconds of battery life left, + * or NULL to ignore. This will be filled in with -1 if we + * can't determine a value or there is no battery. + * \param percent a pointer filled in with the percentage of battery life + * left, between 0 and 100, or NULL to ignore. This will be + * filled in with -1 we can't determine a value or there is no + * battery. + * \returns the current battery state or `SDL_POWERSTATE_ERROR` on failure; + * call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. */