diff --git a/include/SDL3/SDL_main.h b/include/SDL3/SDL_main.h index 055efb1ea..757f660a2 100644 --- a/include/SDL3/SDL_main.h +++ b/include/SDL3/SDL_main.h @@ -277,23 +277,21 @@ typedef void (SDLCALL *SDL_AppQuit_func)(void *appstate); * to use a global variable. If this isn't set, the pointer will be NULL in * future entry points. * - * If this function returns SDL_APP_CONTINUE, the app will proceed - * to normal operation, and will begin receiving repeated calls to - * SDL_AppIterate and SDL_AppEvent for the life of the program. If this - * function returns SDL_APP_FAILURE, SDL will call SDL_AppQuit - * and terminate the process with an exit code that reports an error to the - * platform. If it returns SDL_APP_SUCCESS, SDL calls - * SDL_AppQuit and terminates with an exit code that reports success to the - * platform. + * If this function returns SDL_APP_CONTINUE, the app will proceed to normal + * operation, and will begin receiving repeated calls to SDL_AppIterate and + * SDL_AppEvent for the life of the program. If this function returns + * SDL_APP_FAILURE, SDL will call SDL_AppQuit and terminate the process with + * an exit code that reports an error to the platform. If it returns + * SDL_APP_SUCCESS, SDL calls SDL_AppQuit and terminates with an exit code + * that reports success to the platform. * * \param appstate a place where the app can optionally store a pointer for * future use. * \param argc The standard ANSI C main's argc; number of elements in `argv` * \param argv The standard ANSI C main's argv; array of command line * arguments. - * \returns SDL_APP_FAILURE to terminate with an error, - * SDL_APP_SUCCESS to terminate with success, - * SDL_APP_CONTINUE to continue. + * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to + * terminate with success, SDL_APP_CONTINUE to continue. * * \threadsafety This function is not thread safe. * @@ -332,18 +330,17 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppInit(void **appstate, int argc, char * The `appstate` parameter is an optional pointer provided by the app during * SDL_AppInit(). If the app never provided a pointer, this will be NULL. * - * If this function returns SDL_APP_CONTINUE, the app will continue - * normal operation, receiving repeated calls to SDL_AppIterate and - * SDL_AppEvent for the life of the program. If this function returns - * SDL_APP_FAILURE, SDL will call SDL_AppQuit and terminate the - * process with an exit code that reports an error to the platform. If it - * returns SDL_APP_SUCCESS, SDL calls SDL_AppQuit and - * terminates with an exit code that reports success to the platform. + * If this function returns SDL_APP_CONTINUE, the app will continue normal + * operation, receiving repeated calls to SDL_AppIterate and SDL_AppEvent for + * the life of the program. If this function returns SDL_APP_FAILURE, SDL will + * call SDL_AppQuit and terminate the process with an exit code that reports + * an error to the platform. If it returns SDL_APP_SUCCESS, SDL calls + * SDL_AppQuit and terminates with an exit code that reports success to the + * platform. * * \param appstate an optional pointer, provided by the app in SDL_AppInit. - * \returns SDL_APP_FAILURE to terminate with an error, - * SDL_APP_SUCCESS to terminate with success, - * SDL_APP_CONTINUE to continue. + * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to + * terminate with success, SDL_APP_CONTINUE to continue. * * \threadsafety This function is not thread safe. * @@ -379,19 +376,18 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppIterate(void *appstate); * The `appstate` parameter is an optional pointer provided by the app during * SDL_AppInit(). If the app never provided a pointer, this will be NULL. * - * If this function returns SDL_APP_CONTINUE, the app will continue - * normal operation, receiving repeated calls to SDL_AppIterate and - * SDL_AppEvent for the life of the program. If this function returns - * SDL_APP_FAILURE, SDL will call SDL_AppQuit and terminate the - * process with an exit code that reports an error to the platform. If it - * returns SDL_APP_SUCCESS, SDL calls SDL_AppQuit and - * terminates with an exit code that reports success to the platform. + * If this function returns SDL_APP_CONTINUE, the app will continue normal + * operation, receiving repeated calls to SDL_AppIterate and SDL_AppEvent for + * the life of the program. If this function returns SDL_APP_FAILURE, SDL will + * call SDL_AppQuit and terminate the process with an exit code that reports + * an error to the platform. If it returns SDL_APP_SUCCESS, SDL calls + * SDL_AppQuit and terminates with an exit code that reports success to the + * platform. * * \param appstate an optional pointer, provided by the app in SDL_AppInit. * \param event the new event for the app to examine. - * \returns SDL_APP_FAILURE to terminate with an error, - * SDL_APP_SUCCESS to terminate with success, - * SDL_APP_CONTINUE to continue. + * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to + * terminate with success, SDL_APP_CONTINUE to continue. * * \threadsafety This function is not thread safe. *