From e7969553f880b09b439891ddce36aa5c150018da Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Fri, 6 Sep 2024 02:17:29 +0000 Subject: [PATCH] Sync SDL3 wiki -> header --- include/SDL3/SDL_iostream.h | 3 ++- include/SDL3/SDL_joystick.h | 3 ++- include/SDL3/SDL_stdinc.h | 6 ++++-- include/SDL3/SDL_storage.h | 4 +++- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h index b82116ddc8..b5cb2f03bd 100644 --- a/include/SDL3/SDL_iostream.h +++ b/include/SDL3/SDL_iostream.h @@ -366,7 +366,8 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromDynamicMem(void); * This function makes a copy of `iface` and the caller does not need to keep * it around after this call. * - * \param iface the interface that implements this SDL_IOStream, initialized using SDL_INIT_INTERFACE(). + * \param iface the interface that implements this SDL_IOStream, initialized + * using SDL_INIT_INTERFACE(). * \param userdata the pointer that will be passed to the interface functions. * \returns a pointer to the allocated memory on success or NULL on failure; * call SDL_GetError() for more information. diff --git a/include/SDL3/SDL_joystick.h b/include/SDL3/SDL_joystick.h index da28a24460..8f68b24d1b 100644 --- a/include/SDL3/SDL_joystick.h +++ b/include/SDL3/SDL_joystick.h @@ -414,7 +414,8 @@ typedef struct SDL_VirtualJoystickSensorDesc /** * The structure that describes a virtual joystick. * - * This structure should be initialized using SDL_INIT_INTERFACE(). All elements of this structure are optional. + * This structure should be initialized using SDL_INIT_INTERFACE(). All + * elements of this structure are optional. * * \since This struct is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_stdinc.h b/include/SDL3/SDL_stdinc.h index 9ae20d7c97..511c9caa3a 100644 --- a/include/SDL3/SDL_stdinc.h +++ b/include/SDL3/SDL_stdinc.h @@ -532,7 +532,8 @@ extern "C" { /** * A macro to initialize an SDL interface. * - * This macro will initialize an SDL interface structure and should be called before you fill out the fields with your implementation. + * This macro will initialize an SDL interface structure and should be called + * before you fill out the fields with your implementation. * * You can use it like this: * @@ -547,7 +548,8 @@ extern "C" { * stream = SDL_OpenIO(&iface, NULL); * ``` * - * If you are using designated initializers, you can use the size of the interface as the version, e.g. + * If you are using designated initializers, you can use the size of the + * interface as the version, e.g. * * ```c * SDL_IOStreamInterface iface = { diff --git a/include/SDL3/SDL_storage.h b/include/SDL3/SDL_storage.h index d965cfd516..2b2259a89a 100644 --- a/include/SDL3/SDL_storage.h +++ b/include/SDL3/SDL_storage.h @@ -106,6 +106,7 @@ typedef struct SDL_StorageInterface SDL_COMPILE_TIME_ASSERT(SDL_StorageInterface_SIZE, (sizeof(void *) == 4 && sizeof(SDL_StorageInterface) == 48) || (sizeof(void *) == 8 && sizeof(SDL_StorageInterface) == 96)); + /** * An abstract interface for filesystem access. * @@ -195,7 +196,8 @@ extern SDL_DECLSPEC SDL_Storage * SDLCALL SDL_OpenFileStorage(const char *path); * This function makes a copy of `iface` and the caller does not need to keep * it around after this call. * - * \param iface the interface that implements this storage, initialized using SDL_INIT_INTERFACE(). + * \param iface the interface that implements this storage, initialized using + * SDL_INIT_INTERFACE(). * \param userdata the pointer that will be passed to the interface functions. * \returns a storage container on success or NULL on failure; call * SDL_GetError() for more information.