From 32587bd7de23c057cf791e1b93e74885688c3e56 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Tue, 10 Oct 2023 10:19:34 -0400 Subject: [PATCH] Sync wiki -> header --- docs/README-android.md | 2 +- include/SDL_stdinc.h | 4 ++-- include/SDL_system.h | 3 ++- include/SDL_video.h | 3 ++- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/README-android.md b/docs/README-android.md index 5e25cab77..b886f06db 100644 --- a/docs/README-android.md +++ b/docs/README-android.md @@ -72,7 +72,7 @@ done in the build directory for the app! For more complex projects, follow these instructions: 1. Get the source code for SDL and copy the 'android-project' directory located at SDL/android-project to a suitable location. Also make sure to rename it to your project name (In these examples: YOURPROJECT). - + (The 'android-project' directory can basically be seen as a sort of starting point for the android-port of your project. It contains the glue code between the Android Java 'frontend' and the SDL code 'backend'. It also contains some standard behaviour, like how events should be handled, which you will be able to change.) 2. Move or [symlink](https://en.wikipedia.org/wiki/Symbolic_link) the SDL directory into the "YOURPROJECT/app/jni" directory diff --git a/include/SDL_stdinc.h b/include/SDL_stdinc.h index 182ed86ee..47f609bb7 100644 --- a/include/SDL_stdinc.h +++ b/include/SDL_stdinc.h @@ -688,8 +688,8 @@ extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf, size_t * outbytesleft); /** - * This function converts a buffer or string between encodings in one pass, returning a - * string that must be freed with SDL_free() or NULL on error. + * This function converts a buffer or string between encodings in one pass, + * returning a string that must be freed with SDL_free() or NULL on error. * * \since This function is available since SDL 2.0.0. */ diff --git a/include/SDL_system.h b/include/SDL_system.h index 261ddabf4..fa96ef379 100644 --- a/include/SDL_system.h +++ b/include/SDL_system.h @@ -617,7 +617,8 @@ extern DECLSPEC int SDLCALL SDL_GDKGetTaskQueue(XTaskQueueHandle * outTaskQueue) * This is effectively a synchronous version of XUserAddAsync, which always * prefers the default user and allows a sign-in UI. * - * \param outUserHandle a pointer to be filled in with the default user handle. + * \param outUserHandle a pointer to be filled in with the default user + * handle. * \returns 0 if success, -1 if any error occurs. * * \since This function is available since SDL 2.28.0. diff --git a/include/SDL_video.h b/include/SDL_video.h index c8b2d7a0d..48ff27f54 100644 --- a/include/SDL_video.h +++ b/include/SDL_video.h @@ -1278,7 +1278,8 @@ extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window, /** * Return whether the window has a surface associated with it. * - * \returns SDL_TRUE if there is a surface associated with the window, or SDL_FALSE otherwise. + * \returns SDL_TRUE if there is a surface associated with the window, or + * SDL_FALSE otherwise. * * \since This function is available since SDL 2.28.0. *