mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-15 06:16:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

SDL_main.h: Minor documentation tweaks.

Browse Source
This commit is contained in:
Ryan C. Gordon
2024-05-03 09:48:27 -04:00
parent e86f22b52b
commit 21c181b3b4
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/SDL3/SDL_main.h
View File

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