SDL_main.h: Minor documentation tweaks.

This commit is contained in:
Ryan C. Gordon 2024-05-03 09:48:27 -04:00
parent e86f22b52b
commit 21c181b3b4
No known key found for this signature in database
GPG key ID: FA148B892AB48044

View file

@ -156,11 +156,11 @@
/**
* Inform SDL to use the main callbacks instead of main.
*
* SDL does not define this macro, but will check if it is defined to any
* value in SDL_main.h. If defined, SDL will expect the app to provide several
* functions: SDL_AppInit, SDL_AppEvent, SDL_AppIterate, and SDL_AppQuit. The
* app should not provide a `main` function in this case, and doing so will
* likely cause the build to fail.
* SDL does not define this macro, but will check if it is defined when
* including `SDL_main.h`. If defined, SDL will expect the app to provide
* several functions: SDL_AppInit, SDL_AppEvent, SDL_AppIterate, and
* SDL_AppQuit. The app should not provide a `main` function in this case, and
* doing so will likely cause the build to fail.
*
* Please see [README/main-functions](README/main-functions), (or
* docs/README-main-functions.md in the source tree) for a more detailed