Sync SDL3 wiki -> header

include/SDL3/SDL_main.h

@@ -440,7 +440,8 @@ extern SDLMAIN_DECLSPEC void SDLCALL SDL_AppQuit(void *appstate);
  *
  * \param argc an ANSI-C style main function's argc.
  * \param argv an ANSI-C style main function's argv.
- * \returns Generally 0 is considered successful program completion, small non-zero values are considered errors.
+ * \returns Generally 0 is considered successful program completion, small
+ *          non-zero values are considered errors.
  *
  * \since This datatype is available since SDL 3.0.0.
  */
@@ -469,7 +470,8 @@ typedef int (SDLCALL *SDL_main_func)(int argc, char *argv[]);
  *
  * \param argc an ANSI-C style main function's argc.
  * \param argv an ANSI-C style main function's argv.
- * \returns Generally 0 is considered successful program completion, small non-zero values are considered errors.
+ * \returns Generally 0 is considered successful program completion, small
+ *          non-zero values are considered errors.
  *
  * \threadsafety This is the program entry point.
  *
@@ -506,9 +508,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetMainReady(void);
  *             if the platform's main-equivalent has no argc
  * \param argv The argv parameter from the application's main() function, or
  *             NULL if the platform's main-equivalent has no argv
- * \param mainFunction Your SDL app's C-style main(). NOT
+ * \param mainFunction Your SDL app's C-style main(). NOT the function you're
- *                     the function you're calling this from! Its name doesn't
+ *                     calling this from! Its name doesn't matter; it doesn't
- *                     matter; it doesn't literally have to be `main`.
+ *                     literally have to be `main`.
  * \param reserved should be NULL (reserved for future use, will probably be
  *                 platform-specific then)
  * \returns the return value from mainFunction: 0 on success, -1 on failure;

include/SDL3/SDL_stdinc.h

@@ -531,9 +531,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetOriginalMemoryFunctions(SDL_malloc_func
  * \param realloc_func filled with realloc function
  * \param free_func filled with free function
  *
- * \threadsafety This does not hold a lock, so do not call this in the unlikely
+ * \threadsafety This does not hold a lock, so do not call this in the
- *               event of a background thread calling SDL_SetMemoryFunctions
+ *               unlikely event of a background thread calling
- *               simultaneously.
+ *               SDL_SetMemoryFunctions simultaneously.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -2541,18 +2541,18 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
  *
  * This function converts a buffer or string between encodings in one pass.
  *
- * The string does not need to be NULL-terminated; this function operates
+ * The string does not need to be NULL-terminated; this function operates on
- * on the number of bytes specified in `inbytesleft` whether there is a
+ * the number of bytes specified in `inbytesleft` whether there is a NULL
- * NULL character anywhere in the buffer.
+ * character anywhere in the buffer.
  *
  * The returned string is owned by the caller, and should be passed to
  * SDL_free when no longer needed.
  *
- * \param tocode the character encoding of the output string. Examples are "UTF-8", "UCS-4", etc.
+ * \param tocode the character encoding of the output string. Examples are
+ *               "UTF-8", "UCS-4", etc.
  * \param fromcode the character encoding of data in `inbuf`.
  * \param inbuf the string to convert to a different encoding.
  * \param inbytesleft the size of the input string _in bytes_.
- *
  * \returns a new string, converted to the new encoding, or NULL on error.
  *
  * \since This function is available since SDL 3.0.0.
@@ -2643,7 +2643,8 @@ size_t wcslcat(wchar_t *dst, const wchar_t *src, size_t size);
  *
  * \param a the multiplicand
  * \param b the multiplier
- * \param ret on non-overflow output, stores the multiplication result. May not be NULL.
+ * \param ret on non-overflow output, stores the multiplication result. May
+ *            not be NULL.
  * \returns -1 on overflow, 0 if result doesn't overflow.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -2685,7 +2686,8 @@ SDL_FORCE_INLINE int SDL_size_mul_overflow_builtin (size_t a,
  *
  * \param a the first addend.
  * \param b the second addend.
- * \param ret on non-overflow output, stores the addition result. May not be NULL.
+ * \param ret on non-overflow output, stores the addition result. May not be
+ *            NULL.
  * \returns -1 on overflow, 0 if result doesn't overflow.
  *
  * \threadsafety It is safe to call this function from any thread.